-
-
Save Scot3004/56723aa4237961b5a250ffd17c53996f to your computer and use it in GitHub Desktop.
screenpy.ipynb
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| { | |
| "cells": [ | |
| { | |
| "cell_type": "markdown", | |
| "metadata": { | |
| "id": "view-in-github", | |
| "colab_type": "text" | |
| }, | |
| "source": [ | |
| "<a href=\"https://colab.research.google.com/gist/Scot3004/56723aa4237961b5a250ffd17c53996f/screenpy.ipynb\" target=\"_parent\"><img src=\"https://colab.research.google.com/assets/colab-badge.svg\" alt=\"Open In Colab\"/></a>" | |
| ] | |
| }, | |
| { | |
| "cell_type": "markdown", | |
| "metadata": { | |
| "id": "7gOP0A6NHG4u" | |
| }, | |
| "source": [ | |
| "# ScreenPy\n", | |
| "\n", | |
| "Es una implementación del patrón screenplay en python\n", | |
| "\n", | |
| "En este notebook es una traducción del ejemplo completo de screenplay https://screenpy-docs.readthedocs.io/en/latest/example.html" | |
| ] | |
| }, | |
| { | |
| "cell_type": "markdown", | |
| "metadata": { | |
| "id": "asVIF3ssHXTB" | |
| }, | |
| "source": [ | |
| "" | |
| ] | |
| }, | |
| { | |
| "cell_type": "code", | |
| "execution_count": null, | |
| "metadata": { | |
| "colab": { | |
| "base_uri": "https://localhost:8080/" | |
| }, | |
| "id": "hwzV41mrQADs", | |
| "outputId": "5cdd97c9-180f-46f4-9c65-b0da248045d3" | |
| }, | |
| "outputs": [ | |
| { | |
| "name": "stderr", | |
| "output_type": "stream", | |
| "text": [ | |
| "11692.70s - pydevd: Sending message related to process being replaced timed-out after 5 seconds\n" | |
| ] | |
| }, | |
| { | |
| "name": "stdout", | |
| "output_type": "stream", | |
| "text": [ | |
| "Requirement already satisfied: screenpy in /home/scot3004/proyectos/comunidades/screenpy_examples/venv/lib/python3.8/site-packages (4.0.1)\n", | |
| "Requirement already satisfied: typing-extensions<4.2,>=4.1.1 in /home/scot3004/proyectos/comunidades/screenpy_examples/venv/lib/python3.8/site-packages (from screenpy) (4.1.1)\n", | |
| "Requirement already satisfied: PyHamcrest<2.1,>=2.0.0 in /home/scot3004/proyectos/comunidades/screenpy_examples/venv/lib/python3.8/site-packages (from screenpy) (2.0.3)\n", | |
| "\u001b[33mWARNING: You are using pip version 19.2.3, however version 22.2.1 is available.\n", | |
| "You should consider upgrading via the 'pip install --upgrade pip' command.\u001b[0m\n", | |
| "Note: you may need to restart the kernel to use updated packages.\n" | |
| ] | |
| } | |
| ], | |
| "source": [ | |
| "%pip install screenpy" | |
| ] | |
| }, | |
| { | |
| "cell_type": "markdown", | |
| "metadata": { | |
| "id": "TAkB1soTG2Qs" | |
| }, | |
| "source": [ | |
| "## Actores (Actor)\n", | |
| "\n", | |
| "Los actores representan a sus usuarios finales. Se les otorgarán Habilidades, realizarán Acciones, harán Preguntas y (con suerte) cumplirán Resoluciones durante el transcurso de sus pruebas.\n", | |
| "\n", | |
| "Instanciar un Actor es simple:" | |
| ] | |
| }, | |
| { | |
| "cell_type": "code", | |
| "execution_count": null, | |
| "metadata": { | |
| "id": "QI92nshLPvxl" | |
| }, | |
| "outputs": [], | |
| "source": [ | |
| "from screenpy import AnActor\n", | |
| "\n", | |
| "Cameron = AnActor.named(\"Cameron\")\n", | |
| "Polly = AnActor.named(\"Polly\")" | |
| ] | |
| }, | |
| { | |
| "cell_type": "markdown", | |
| "metadata": { | |
| "id": "JeIR_TdYVm7f" | |
| }, | |
| "source": [ | |
| "El nombre que le dé a sus Actores se utilizará para registrar las Acciones que realizan. Para realizar Acciones más interesantes, su Actor necesitará algunas Habilidades:" | |
| ] | |
| }, | |
| { | |
| "cell_type": "code", | |
| "execution_count": null, | |
| "metadata": { | |
| "id": "kfxZ-z70Vm7f" | |
| }, | |
| "outputs": [], | |
| "source": [ | |
| "# grant abilities on instantiation\n", | |
| "Cameron = AnActor.named(\"Cameron\").who_can(ControlCameras())\n", | |
| "\n", | |
| "# or later, if you want\n", | |
| "Polly.can(PollTheAudience())\n" | |
| ] | |
| }, | |
| { | |
| "cell_type": "markdown", | |
| "metadata": { | |
| "id": "sSLf16X4Vm7g" | |
| }, | |
| "source": [ | |
| "De nuestro ejemplo completo, otorgamos a Cameron la capacidad de controlar cámaras y a Polly la capacidad de sondear a la audiencia. Estas Habilidades permitieron a nuestros Actores realizar varias Acciones." | |
| ] | |
| }, | |
| { | |
| "cell_type": "markdown", | |
| "metadata": { | |
| "id": "T5Up61q6IU4T" | |
| }, | |
| "source": [ | |
| "## Habilidades (Abilities)\n", | |
| "\n", | |
| "Las habilidades habilitan a los Actores a usar librerias, conectarse con recursos, o bien cualquier otra cosa\n", | |
| "\n", | |
| "En nuestro ejemplo completo, otorgamos a Cameron la capacidad de controlar cámaras. Esta habilidad utiliza una biblioteca inventada, cam_py, para controlar las cámaras. Esta habilidad podría verse así:" | |
| ] | |
| }, | |
| { | |
| "cell_type": "code", | |
| "execution_count": null, | |
| "metadata": { | |
| "id": "TbpNqzaqVm7h", | |
| "outputId": "e4485c92-1bf8-4ef5-f5c6-d467e0f6ccab" | |
| }, | |
| "outputs": [ | |
| { | |
| "data": { | |
| "text/plain": [ | |
| "__main__.ControlCameras" | |
| ] | |
| }, | |
| "execution_count": 4, | |
| "metadata": {}, | |
| "output_type": "execute_result" | |
| } | |
| ], | |
| "source": [ | |
| "\n", | |
| "import cam_py\n", | |
| "\n", | |
| "\n", | |
| "class ControlCameras:\n", | |
| " \"\"\"Enable an Actor to control cameras through cam_py.\n", | |
| "\n", | |
| " Examples::\n", | |
| "\n", | |
| " the_actor.can(ControlCameras())\n", | |
| " \"\"\"\n", | |
| "\n", | |
| " def __init__(self) -> None:\n", | |
| " self.campy_session = cam_py.RecordingSession()\n", | |
| " self.cameras = []\n", | |
| "\n", | |
| " def forget(self) -> None:\n", | |
| " for camera in self.cameras:\n", | |
| " camera.stop()\n", | |
| " self.campy_session.wrap()\n", | |
| "\n", | |
| "ControlCameras" | |
| ] | |
| }, | |
| { | |
| "cell_type": "markdown", | |
| "metadata": { | |
| "id": "KAVoK5dYVm7i" | |
| }, | |
| "source": [ | |
| "Las habilidades son olvidables, lo que significa que una habilidad debe tener un método `forget`. Este método se encarga de limpiar los cabos sueltos que cuelgan.\n", | |
| "\n", | |
| "Tanto las Acciones como las Preguntas pueden usar las Habilidades de un Actor." | |
| ] | |
| }, | |
| { | |
| "cell_type": "markdown", | |
| "metadata": { | |
| "id": "oPuS0qDVJNGx" | |
| }, | |
| "source": [ | |
| "## Acciones (Actions)\n", | |
| "\n", | |
| "Durante una prueba, tus Actores realizarán varias Acciones. Los actores realizan acciones para configurar y realizar la prueba.\n", | |
| "\n", | |
| "En nuestro ejemplo completo, Cameron usa varias acciones. Uno de ellos es StartRecording. \n", | |
| "\n", | |
| "Así es como se podría codificar esa acción:\n" | |
| ] | |
| }, | |
| { | |
| "cell_type": "code", | |
| "execution_count": null, | |
| "metadata": { | |
| "id": "4X8ileNzVm7j" | |
| }, | |
| "outputs": [], | |
| "source": [ | |
| "# %load actions/start_recording.py\n", | |
| "\"\"\"\n", | |
| "Start recording a screenplay on one or more cameras!\n", | |
| "\"\"\"\n", | |
| "\n", | |
| "import cam_py\n", | |
| "from screenpy import Actor\n", | |
| "from screenpy.pacing import beat\n", | |
| "\n", | |
| "from ..abilities import ControlCameras\n", | |
| "\n", | |
| "\n", | |
| "class StartRecording:\n", | |
| " \"\"\"Starts recording on one or more cameras.\n", | |
| "\n", | |
| " Examples::\n", | |
| "\n", | |
| " the_actor.attempts_to(StartRecording())\n", | |
| "\n", | |
| " camera = Camera(\"Character\")\n", | |
| " the_actor.attempts_to(StartRecording.on(camera))\n", | |
| "\n", | |
| " camera1 = Camera(\"Character1\")\n", | |
| " camera2 = Camera(\"Character2\")\n", | |
| " the_actor.attempts_to(StartRecording.on(camera1).and_(camera2))\n", | |
| " \"\"\"\n", | |
| "\n", | |
| " def on(self, camera: cam_py.Camera) -> \"StartRecording\":\n", | |
| " \"\"\"Record on an already-created camera.\"\"\"\n", | |
| " self.cameras.append(camera)\n", | |
| " return self\n", | |
| "\n", | |
| " and_ = on\n", | |
| "\n", | |
| " @beat(\"{} starts recording on {cameras_to_log}.\")\n", | |
| " def perform_as(self, the_actor: Actor) -> None:\n", | |
| " \"\"\"Direct the actor to start recording on their cameras.\"\"\"\n", | |
| " if not self.cameras:\n", | |
| " self.cameras = [cam_py.Camera(\"Main\")]\n", | |
| "\n", | |
| " campy_session = the_actor.ability_to(ControlCameras).campy_session\n", | |
| " for camera in self.cameras:\n", | |
| " camera.record(self.script)\n", | |
| " campy_session.add_camera(camera)\n", | |
| "\n", | |
| " @property\n", | |
| " def cameras_to_log(self) -> str:\n", | |
| " \"\"\"Get a nice list of all the cameras for the logged beat.\"\"\"\n", | |
| " return \", \".join(camera.character for camera in self.cameras)\n", | |
| "\n", | |
| " def __init__(self, script: str) -> None:\n", | |
| " self.script = script\n", | |
| " self.cameras = []\n" | |
| ] | |
| }, | |
| { | |
| "cell_type": "markdown", | |
| "metadata": { | |
| "id": "HNmF7RnCJSWg" | |
| }, | |
| "source": [ | |
| "## Tareas (Tasks)\n", | |
| "\n", | |
| "Las tareas son una agrupación de acciones. tienen un método `perform_as` ver clase [Performable](https://screenpy-docs.readthedocs.io/en/latest/api/protocols.html#screenpy.protocols.Performable), al igual que las acciones, lo que significa que tienen un método perform_as. Ese es el único requisito.\n", | |
| "\n", | |
| "Puede crear tareas para un grupo repetido de acciones, como `LogIn` para iniciar sesión. También puede crear tareas para describir un grupo de acciones que solo realiza una vez con un nombre más descriptivo, como `ChangeProfilePicture`.\n", | |
| "\n", | |
| "Se utilizaron dos tareas en nuestro ejemplo completo: `CutToCloseUp` y `DollyZoom`. Veamos cómo podría implementarse `DollyZoom`:" | |
| ] | |
| }, | |
| { | |
| "cell_type": "code", | |
| "execution_count": null, | |
| "metadata": { | |
| "id": "U1JJSFRoVm7j" | |
| }, | |
| "outputs": [], | |
| "source": [ | |
| "# %load tasks/dolly_zoom.py\n", | |
| "\"\"\"\n", | |
| "Dolly-zoom, that classic tension shot.\n", | |
| "https://en.wikipedia.org/wiki/Dolly_zoom\n", | |
| "\"\"\"\n", | |
| "\n", | |
| "from typing import Optional\n", | |
| "\n", | |
| "from screenpy import Actor\n", | |
| "from screenpy.pacing import beat\n", | |
| "\n", | |
| "from ..abilities import ControlCameras\n", | |
| "from ..actions import Dolly, Simultaneously, Zoom\n", | |
| "\n", | |
| "\n", | |
| "class DollyZoom:\n", | |
| " \"\"\"Perform a dolly zoom (optionally on a character) to enhance drama.\n", | |
| "\n", | |
| " Examples::\n", | |
| "\n", | |
| " the_actor.attempts_to(DollyZoom())\n", | |
| "\n", | |
| " the_actor.attempts_to(DollyZoom.on(\"Alfred Hitchcock\"))\n", | |
| " \"\"\"\n", | |
| "\n", | |
| " @staticmethod\n", | |
| " def on(character: str) -> \"DollyZoom\":\n", | |
| " \"\"\"Specify the character to put in frame before dolly zooming.\"\"\"\n", | |
| " return DollyZoom(character)\n", | |
| "\n", | |
| " @beat(\"{} executes a thrilling dolly zoom{detail}!\")\n", | |
| " def perform_as(self, the_actor: Actor) -> None:\n", | |
| " \"\"\"Direct the actor to dolly zoom on their camera.\"\"\"\n", | |
| " if self.character:\n", | |
| " campy_session = the_actor.ability_to(ControlCameras).campy_session\n", | |
| " camera = campy_session.get_camera_on_character(self.character)\n", | |
| " zoom = Zoom.in_().on_camera(camera)\n", | |
| " else:\n", | |
| " zoom = Zoom.in_()\n", | |
| "\n", | |
| " the_actor.attempts_to(\n", | |
| " Simultaneously(\n", | |
| " Dolly().backward(),\n", | |
| " zoom,\n", | |
| " ),\n", | |
| " )\n", | |
| "\n", | |
| " def __init__(self, character: Optional[str] = None) -> None:\n", | |
| " self.character = character\n", | |
| " self.detail = f\" on {character}\" if character else \"\"\n" | |
| ] | |
| }, | |
| { | |
| "cell_type": "markdown", | |
| "metadata": { | |
| "id": "GDcORT-PVm7k" | |
| }, | |
| "source": [ | |
| "Como puede ver, esta Tarea simplemente realiza otras tres Acciones.\n", | |
| "`Simultaneously`, es una acción en `cam_py` que realiza todas las acciones dadas a la vez;\n", | |
| "`Dolly`, que mueve la cámara en la dirección especificada;\n", | |
| "`Zoom`, que acerca o aleja la cámara.\n", | |
| "\n", | |
| "El Narrador leerá las líneas `beat()` para cada acción. La línea de tareas de `DollyZoom` aparecerá para encapsular las líneas de otras acciones. Así es como se ve desde el [StdOutAdapter](https://screenpy-docs.readthedocs.io/en/latest/api/narrator.html#stdoutadapter) incorporado:\n", | |
| "\n", | |
| "```bash\n", | |
| "INFO screenpy:stdout_adapter.py:42 Cameron executes a dramatic dolly zoom!\n", | |
| "INFO screenpy:stdout_adapter.py:42 Cameron performs some thrilling camerawork simultaneously!\n", | |
| "INFO screenpy:stdout_adapter.py:42 Cameron dollies the active camera backward.\n", | |
| "INFO screenpy:stdout_adapter.py:42 Cameron zooms in.\n", | |
| "```" | |
| ] | |
| }, | |
| { | |
| "cell_type": "markdown", | |
| "metadata": { | |
| "id": "MQ7JdKzzJZsM" | |
| }, | |
| "source": [ | |
| "## Preguntas (Questions)\n", | |
| "\n", | |
| "Cuando esté listo para hacer una verificación (assert) en su prueba, su actor puede hacer una pregunta. La respuesta a esta Pregunta se comparara con una Resolución.\n", | |
| "Este emparejamiento forma una afirmación en ScreenPy.\n", | |
| "\n", | |
| "Nuestro ejemplo completo usa dos preguntas: `AudienceTension` y `TopAudienceReaction`. Veamos cómo se vería esto último:" | |
| ] | |
| }, | |
| { | |
| "cell_type": "code", | |
| "execution_count": null, | |
| "metadata": { | |
| "id": "uHHPTSoEVm7k" | |
| }, | |
| "outputs": [], | |
| "source": [ | |
| "# %load questions/top_audience_reaction.py\n", | |
| "\"\"\"\n", | |
| "Gather information about the audience's tension.\n", | |
| "\"\"\"\n", | |
| "\n", | |
| "from screenpy import Actor\n", | |
| "\n", | |
| "from ..abilities import PollTheAudience\n", | |
| "\n", | |
| "\n", | |
| "class TopAudienceReaction:\n", | |
| " \"\"\"Ask about the audience's most popular reaction.\n", | |
| "\n", | |
| " Examples::\n", | |
| "\n", | |
| " the_actor.should(See.the(TopAudienceReaction(), Equals(LAUGHING))\n", | |
| " \"\"\"\n", | |
| "\n", | |
| " def answered_by(self, the_actor: Actor) -> str:\n", | |
| " \"\"\"Direct the actor to ask about the audience's top mood.\"\"\"\n", | |
| " pollster = the_actor.ability_to(PollTheAudience).poll_connection\n", | |
| " return pollster.poll_mood().top_mood\n" | |
| ] | |
| }, | |
| { | |
| "cell_type": "markdown", | |
| "metadata": { | |
| "id": "M5TID9G0Vm7l" | |
| }, | |
| "source": [ | |
| "Una pregunta es [Answerable](https://screenpy-docs.readthedocs.io/en/latest/api/protocols.html#screenpy.protocols.Answerable), quiere decir que tiene un método `answered_by`.\n", | |
| "\n", | |
| "Pasar una pregunta junto con una resolución a la acción [See](https://screenpy-docs.readthedocs.io/en/latest/api/actions.html#screenpy.actions.See) es cómo hacer afirmaciones en ScreenPy. La Pregunta proporciona el valor real mientras que la Resolución proporciona el valor esperado.\n", | |
| "\n" | |
| ] | |
| }, | |
| { | |
| "cell_type": "markdown", | |
| "metadata": { | |
| "id": "JYQV1yRxJXzv" | |
| }, | |
| "source": [ | |
| "## Resoluciones (Resolutions)\n", | |
| "\n", | |
| "Las resoluciones proporcionan tanto el valor esperado como el método de comparación para la respuesta a una pregunta. Emparejar una pregunta y una resolución forma el paso de afirmación de sus pruebas.\n", | |
| "\n", | |
| "Hubo un par de ejemplos de afirmaciones en nuestro Ejemplo completo, ambos realizados por Polly. Uno usó la Resolución [Equals](https://screenpy-docs.readthedocs.io/en/latest/api/resolutions.html#isequalto) incorporada, mientras que el otro usó una Resolución `IsPalpable` personalizada. Examinemos esto último.\n", | |
| "\n", | |
| "Todas las resoluciones heredan de la clase `BaseResolution`. Todo lo que se necesita es una línea y una función de \"matcher\".\n", | |
| "\n", | |
| "La línea aparece en el registro. Escriba la línea de tal manera que describa el valor esperado mientras completa la oración, \"Esperando que sea...\". Puede usar {expectation} aquí para hacer referencia al valor esperado.\n", | |
| "\n", | |
| "La función \"matcher\" puede provenir de [PyHamcrest](https://github.com/hamcrest/PyHamcrest#pyhamcrest), o puede ser una funcionalidad personalizada escrita por usted.\n", | |
| "\n", | |
| "De todos modos, `IsPalpable` usa el \"matcher\" personalizado `HasSaturationGreaterThan`. Así es como se pueden ensamblar:\n", | |
| "\n" | |
| ] | |
| }, | |
| { | |
| "cell_type": "code", | |
| "execution_count": null, | |
| "metadata": { | |
| "id": "Krlz5SjkVm7l" | |
| }, | |
| "outputs": [], | |
| "source": [ | |
| "# %load resolutions/matchers/has_saturation_greater_than.py\n", | |
| "from typing import Any\n", | |
| "\n", | |
| "from hamcrest.core.base_matcher import BaseMatcher\n", | |
| "from hamcrest.core.description import Description\n", | |
| "\n", | |
| "\n", | |
| "class HasSaturationGreaterThan(BaseMatcher):\n", | |
| " \"\"\"Assert that a mood object has at least a specific saturation level.\"\"\"\n", | |
| "\n", | |
| " def _matches(self, item: Any) -> bool:\n", | |
| " \"\"\"Whether the assertion passes.\"\"\"\n", | |
| " return self.saturation_level <= item.saturation\n", | |
| "\n", | |
| " def describe_to(self, description: Description) -> None:\n", | |
| " \"\"\"Describe the passing case.\"\"\"\n", | |
| " description.append_text(\n", | |
| " f\"the mood has a saturation level of at least {self.saturation_level}\"\n", | |
| " )\n", | |
| "\n", | |
| " def describe_mismatch(self, item: Any, mismatch_description: Description) -> None:\n", | |
| " \"\"\"Description used when a match fails.\"\"\"\n", | |
| " mismatch_description.append_text(\n", | |
| " f\"the saturation level was less than {self.saturation_level}\"\n", | |
| " )\n", | |
| "\n", | |
| " def describe_match(self, item: Any, match_description: Description) -> None:\n", | |
| " \"\"\"Description used when a negated match fails.\"\"\"\n", | |
| " match_description.append_text(\n", | |
| " f\"the saturation level was at least {self.saturation_level}\"\n", | |
| " )\n", | |
| "\n", | |
| " def __init__(self, saturation_level: int) -> None:\n", | |
| " self.saturation_level = saturation_level\n", | |
| "\n", | |
| "\n", | |
| "def is_palpable() -> HasSaturationGreaterThan:\n", | |
| " return HasSaturationGreaterThan(85)\n" | |
| ] | |
| }, | |
| { | |
| "cell_type": "code", | |
| "execution_count": null, | |
| "metadata": { | |
| "id": "HQBc51ZOVm7l" | |
| }, | |
| "outputs": [], | |
| "source": [ | |
| "# %load resolutions/is_palpable.py\n", | |
| "from screenpy.resolutions import BaseResolution\n", | |
| "\n", | |
| "from .matchers.has_saturation_greater_than import is_palpable\n", | |
| "\n", | |
| "\n", | |
| "class IsPalpable(BaseResolution):\n", | |
| " \"\"\"Match a tension level that is very, very high!!!\n", | |
| "\n", | |
| " Examples::\n", | |
| "\n", | |
| " the_actor.should(See.the(AudienceTension(), IsPalpable()))\n", | |
| " \"\"\"\n", | |
| " line = \"a palpable tension!\"\n", | |
| " matcher_function = is_palpable\n" | |
| ] | |
| }, | |
| { | |
| "cell_type": "markdown", | |
| "metadata": { | |
| "id": "XkNQMFwWVm7m" | |
| }, | |
| "source": [ | |
| "¡Eso es realmente todo lo que hay que hacer para crear una Resolución!" | |
| ] | |
| } | |
| ], | |
| "metadata": { | |
| "colab": { | |
| "collapsed_sections": [], | |
| "name": "screenpy.ipynb", | |
| "provenance": [], | |
| "toc_visible": true, | |
| "include_colab_link": true | |
| }, | |
| "kernelspec": { | |
| "display_name": "Python 3 (ipykernel)", | |
| "language": "python", | |
| "name": "python3" | |
| }, | |
| "language_info": { | |
| "codemirror_mode": { | |
| "name": "ipython", | |
| "version": 3 | |
| }, | |
| "file_extension": ".py", | |
| "mimetype": "text/x-python", | |
| "name": "python", | |
| "nbconvert_exporter": "python", | |
| "pygments_lexer": "ipython3", | |
| "version": "3.8.1" | |
| }, | |
| "vscode": { | |
| "interpreter": { | |
| "hash": "e89a1aee0278097340eebc2ad49c3f0724b92baa595a6d8e7a62b356c1b2513d" | |
| } | |
| } | |
| }, | |
| "nbformat": 4, | |
| "nbformat_minor": 0 | |
| } |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment