blob: 9f7ddd8ad72bbf79bbadb5c1f22e8e51c326c371 [file] [log] [blame]
Search.setIndex({"docnames": ["_api/airflow/providers/papermill/index", "_api/airflow/providers/papermill/operators/index", "_api/airflow/providers/papermill/operators/papermill/index", "_api/tests/system/providers/papermill/example_papermill/index", "_api/tests/system/providers/papermill/example_papermill_verify/index", "_api/tests/system/providers/papermill/index", "commits", "index", "installing-providers-from-sources", "operators"], "filenames": ["_api/airflow/providers/papermill/index.rst", "_api/airflow/providers/papermill/operators/index.rst", "_api/airflow/providers/papermill/operators/papermill/index.rst", "_api/tests/system/providers/papermill/example_papermill/index.rst", "_api/tests/system/providers/papermill/example_papermill_verify/index.rst", "_api/tests/system/providers/papermill/index.rst", "commits.rst", "index.rst", "installing-providers-from-sources.rst", "operators.rst"], "titles": ["<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.papermill</span></code>", "<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.papermill.operators</span></code>", "<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.papermill.operators.papermill</span></code>", "<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">tests.system.providers.papermill.example_papermill</span></code>", "<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">tests.system.providers.papermill.example_papermill_verify</span></code>", "<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">tests.system.providers.papermill</span></code>", "Package apache-airflow-providers-papermill", "<code class=\"docutils literal notranslate\"><span class=\"pre\">apache-airflow-providers-papermill</span></code>", "Installing from sources", "Papermill"], "terms": {"oper": [0, 6, 7], "3": [0, 1, 2, 3, 4, 5, 8, 9], "0": [0, 1, 2, 3, 4, 5, 8, 9], "2": [0, 1, 2, 3, 4, 5, 8, 9], "4": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9], "dev0": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9], "thi": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9], "i": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9], "an": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9], "experiment": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9], "featur": [0, 1, 2, 3, 4, 5, 6, 8, 9], "notebook": [2, 3, 4], "sourc": [2, 3, 4, 7, 9], "base": [2, 3, 4], "lineag": [2, 6], "entiti": 2, "file": [2, 6, 7, 8], "jupyt": [2, 9], "type_hint": 2, "option": 2, "str": 2, "jupyter_notebook": 2, "paramet": [2, 3, 4, 6, 9], "dict": 2, "meta_schema": 2, "papermilloper": [2, 6, 7, 9], "input_nb": [2, 9], "none": [2, 8], "output_nb": [2, 9], "kernel_nam": 2, "language_nam": 2, "kwarg": 2, "model": 2, "baseoper": 2, "execut": [2, 3, 4, 9], "through": 2, "annot": 2, "input": [2, 9], "can": [2, 7, 8, 9], "also": [2, 8], "inlet": [2, 4, 9], "output": [2, 3, 4], "outlet": 2, "set": 2, "name": [2, 6, 7], "kernel": [2, 6, 7], "against": 2, "ignor": 2, "document": [2, 6, 7], "metadata": 2, "supports_lineag": 2, "true": [2, 9], "template_field": [2, 6], "sequenc": [2, 6], "context": [2, 6], "main": [2, 7, 8], "method": 2, "deriv": 2, "when": [2, 6], "creat": [2, 3, 4, 8], "same": 2, "dictionari": 2, "us": [2, 3, 4, 6, 8, 9], "render": 2, "jinja": 2, "templat": [2, 3, 4, 6, 7], "refer": 2, "get_template_context": 2, "more": [2, 6], "dag": [3, 4, 6, 7], "run": [3, 4, 7, 8, 9], "hello_world": [3, 4, 9], "date": [3, 4], "out": [3, 4, 6, 9], "all": [3, 4, 6, 7], "field": [3, 4, 6, 7], "includ": [3, 4, 6], "kei": [3, 4, 8], "ar": [3, 4, 6, 7, 8], "start_dat": [3, 4, 6, 9], "schedule_interv": [3, 4, 9], "dagrun_timeout": [3, 4, 9], "env_id": [3, 4], "dag_id": [3, 4, 9], "example_papermill_oper": 3, "run_thi": [3, 4, 9], "test_run": [3, 4], "example_papermill_operator_verifi": [4, 9], "check_notebook": [4, 9], "execution_d": [4, 9], "verifi": [4, 9], "messag": [4, 9], "example_papermil": [5, 9], "example_papermill_verifi": [5, 9], "detail": [6, 7, 8], "commit": 6, "list": [6, 7], "chang": 6, "version": [6, 7, 8], "For": [6, 8], "high": 6, "level": 6, "changelog": 6, "see": [6, 7], "inform": 6, "latest": 6, "2022": 6, "06": 6, "08": 6, "subject": 6, "04f98cf92d": 6, "fix": 6, "langaug": [6, 7], "overrid": [6, 7], "24301": [6, 7], "717a7588bc": 6, "07": 6, "updat": [6, 7], "descript": 6, "remov": [6, 7, 8], "doubl": 6, "min": 6, "specif": 6, "24292": 6, "aeabe994b3": 6, "prepar": 6, "doc": [6, 7], "mai": 6, "": [6, 8], "releas": [6, 7], "24231": 6, "027b707d21": 6, "05": 6, "add": [6, 7, 9], "explanatori": 6, "note": 6, "contributor": 6, "about": [6, 8], "24229": 6, "b4d50d3be1": 6, "migrat": [6, 7], "exampl": [6, 7, 8], "new": [6, 9], "design": [6, 9], "22456": 6, "24146": 6, "6962d8a355": 6, "27": 6, "support": [6, 7, 9], "specifi": [6, 7], "languag": [6, 7], "23916": [6, 7], "03": 6, "22": 6, "d7dbfb7e26": 6, "bugfix": 6, "22383": 6, "14": 6, "16adc035b1": 6, "classifi": [6, 7], "march": 6, "22226": 6, "f5b96315fe": 6, "feb": 6, "22056": 6, "d94fa37830": 6, "02": 6, "januari": 6, "delai": 6, "21439": 6, "6c3a67d4fc": 6, "2021": [6, 8], "21257": 6, "602abe8394": 6, "01": 6, "20": 6, "type": 6, "line": 6, "now": 6, "sphinx": 6, "autoapi": 6, "typehint": 6, "20951": 6, "12": [6, 8], "31": 6, "f77417eb0d": 6, "k8": 6, "pypi": [6, 7], "compat": 6, "20614": 6, "97496ba2b4": 6, "decemb": 6, "20523": 6, "d56e7b56bb": 6, "30": 6, "have": [6, 7, 9], "mypi": 6, "friendli": 6, "20571": 6, "a0821235fb": 6, "everywher": 6, "20565": 6, "d3f4456363": 6, "04": 6, "20035": [6, 7], "09": 6, "840ea3efb9": 6, "septemb": 6, "18613": 6, "ef037e7021": 6, "29": 6, "static": 6, "default": [6, 9], "arg": 6, "cleanup": 6, "misc": 6, "18597": 6, "a458fcc573": 6, "miscellan": 6, "taskflow": 6, "api": [6, 7], "where": 6, "applic": 6, "18278": 6, "f382a79ada": 6, "18357": [6, 7], "29af57b6d8": 6, "11": [6, 8], "usag": [6, 7], "rang": [6, 7], "len": [6, 7], "enumer": [6, 7], "18174": [6, 7], "0a68588479": 6, "august": 6, "17890": 6, "87f408b1e7": 6, "26": 6, "rc2": 6, "juli": 6, "17116": 6, "0dbd0f420c": 6, "refactor": 6, "default_arg": 6, "pattern": 6, "16872": 6, "18": 6, "bbc627a3da": 6, "16501": 6, "cbf8001d76": 6, "16": 6, "synchron": 6, "after": [6, 7], "buggfix": 6, "16464": 6, "1fba5402bb": 6, "15": 6, "june": 6, "16405": 6, "9c94b72d44": 6, "16294": 6, "37681bca00": 6, "auto": [6, 7, 9], "appli": [6, 7], "apply_default": [6, 7], "decor": [6, 7], "15667": [6, 7], "09674537cb": 6, "emit": [6, 7], "error": [6, 7], "duplic": [6, 7], "id": [6, 7, 8], "15302": [6, 7], "807ad32ce5": 6, "pip": [6, 7, 8], "21": 6, "15576": 6, "40a2476a5d": 6, "28": 6, "interact": 6, "gener": 6, "15518": 6, "68e4c4dcb0": 6, "backport": 6, "14886": 6, "589d6dec92": 6, "next": 6, "wave": 6, "14487": 6, "10343ec29f": 6, "correct": [6, 7, 8], "tool": [6, 7, 9], "rc": [6, 7], "14082": [6, 7], "88bdcfa0df": 6, "14013": 6, "ac2f72c98d": 6, "implement": 6, "13767": 6, "3fd5ef3555": 6, "miss": 6, "logo": 6, "integr": [6, 9], "13717": 6, "295d66f914": 6, "2020": 6, "grammar": 6, "warn": [6, 8], "13380": 6, "6cf76d7ac0": 6, "typo": 6, "upgrad": [6, 7], "command": 6, "13148": 6, "32971a1a2d": 6, "12955": 6, "bd90136aaf": 6, "move": 6, "guid": [6, 8], "12681": 6, "c34ef853c8": 6, "separ": 6, "build": [6, 8], "per": 6, "12444": 6, "0080354502": 6, "readm": [6, 7], "0b2": 6, "batch": 6, "12449": 6, "6889a333cf": 6, "improv": 6, "hook": 6, "ref": 6, "12366": 6, "7825e8f590": 6, "13": 6, "instal": 6, "12304": 6, "85a18e13d9": 6, "point": 6, "project": 6, "page": [6, 8], "cross": 6, "depend": 6, "12212": 6, "59eb5de78c": 6, "up": 6, "come": 6, "0beta1": 6, "12206": 6, "5a439e84eb": 6, "10": [6, 7], "2a1": 6, "11855": 6, "872b1566a1": 6, "25": 6, "setup": 6, "11826": 6, "349b0811c3": 6, "d200": 6, "pydocstyl": 6, "check": [6, 8], "11688": 6, "cb7c67dea9": 6, "11687": 6, "16e7129719": 6, "ad": [6, 7], "11487": 6, "fdd9b6f65b": 6, "enabl": 6, "black": 6, "10543": 6, "cdec301254": 6, "signatur": [6, 8], "sensor": 6, "10205": 6, "aeea71274d": 6, "from": [6, 7, 9], "constructor": 6, "10097": 6, "7d24b088cd": 6, "stop": 6, "example_dag": 6, "9985": 6, "c7e5bce57f": 6, "19": 6, "candid": 6, "6": 6, "23rc1": 6, "9370": 6, "00642a46d0": 6, "remain": 6, "wrongli": 6, "8994": 6, "cdb3f25456": 6, "class": [6, 7], "import": [6, 7, 8], "8991": 6, "375d1ca229": 6, "8898": 6, "12c5e5d8a": 6, "17": 6, "8891": 6, "f3521fb0e3": 6, "regener": 6, "8886": 6, "92585ca4cb": 6, "autom": 6, "8807": 6, "4bde99f132": 6, "23": 6, "make": [6, 9], "pylint": 6, "7802": 6, "3320e432a1": 6, "24": 6, "6817": 6, "lazi": 6, "load": 6, "keep": 6, "user": [6, 8], "face": 6, "untouch": 6, "7517": 6, "97a429f9d0": 6, "6714": 6, "magic": 6, "comment": 6, "utf": 6, "8": 6, "7338": 6, "4c81bcd860": 6, "6698": 6, "shorthand": 6, "notat": 6, "7314": 6, "83c037873f": 6, "6674": [6, 8], "accord": 6, "aip": 6, "7287": 6, "059eda05f8": 6, "6610": 6, "softwar": [6, 8], "7231": 6, "python": [7, 8], "repositori": 7, "you": [7, 8, 9], "top": [7, 8, 9], "exist": 7, "below": [7, 8], "minimum": 7, "via": [7, 8], "scrapbook": 7, "onli": 7, "avail": [7, 8], "explain": 7, "polici": 7, "http": [7, 8], "github": 7, "com": [7, 8], "blob": 7, "md": 7, "mistakenli": 7, "install_requir": 7, "22382": 7, "trove": 7, "framework": 7, "optimis": 7, "connect": 7, "due": 7, "If": [7, 8, 9], "your": [7, 9], "want": [7, 8], "first": [7, 9], "least": 7, "otherwis": 7, "automat": 7, "manual": 7, "db": 7, "complet": 7, "initi": 7, "describ": 8, "download": 8, "apach": [8, 9], "airflow": [8, 9], "provid": [8, 9], "papermil": 8, "offici": 8, "most": 8, "choos": 8, "differ": [8, 9], "select": 8, "drop": 8, "down": 8, "left": 8, "The": 8, "sdist": 8, "whl": 8, "origin": 8, "checksum": 8, "foundat": 8, "asc": 8, "sha512": 8, "those": 8, "code": 8, "link": 8, "abov": 8, "contain": 8, "how": 8, "pgp": 8, "It": 8, "essenti": 8, "sha": 8, "gpg": 8, "pleas": 8, "well": 8, "relev": 8, "distribut": 8, "recommend": 8, "get": 8, "directori": 8, "mirror": 8, "pgpk": 8, "ka": 8, "To": [8, 9], "binari": 8, "follow": 8, "pgpv": 8, "tar": 8, "gz": 8, "made": 8, "sat": 8, "sep": 8, "49": 8, "54": 8, "bst": 8, "rsa": 8, "cde15c6e4d3a8ec4ecf4ba4b6674e08ad7de406f": 8, "issuer": 8, "kaxilnaik": 8, "org": 8, "good": 8, "kaxil": 8, "naik": 8, "unknown": 8, "aka": 8, "gmail": 8, "certifi": 8, "trust": 8, "There": 8, "indic": 8, "belong": 8, "owner": 8, "primari": 8, "fingerprint": 8, "cde1": 8, "5c6e": 8, "4d3a": 8, "8ec4": 8, "ecf4": 8, "ba4b": 8, "e08a": 8, "d7de": 8, "406f": 8, "do": 8, "worri": 8, "certif": 8, "manag": 8, "self": 8, "sign": 8, "why": 8, "By": 8, "server": 8, "previou": 8, "step": 8, "know": 8, "valid": 8, "alreadi": 8, "sum": 8, "shasum": 8, "512": 8, "diff": 8, "should": 8, "match": 8, "one": 8, "local": [8, 9], "script": 8, "bin": 8, "bash": 8, "package_vers": 8, "package_nam": 8, "provider_download_dir": 8, "mktemp": 8, "d": 8, "dep": 8, "dest": 8, "curl": 8, "apache_airflow_providers_papermil": 8, "py3": 8, "ani": 8, "l": 8, "o": [8, 9], "echo": 8, "la": 8, "onc": 8, "instruct": 8, "chapter": 8, "temporari": 8, "folder": 8, "parameter": 9, "perhap": 9, "financi": 9, "report": 9, "wish": 9, "valu": 9, "last": 9, "dai": 9, "month": 9, "begin": 9, "end": 9, "year": 9, "breez": 9, "cell": 9, "tag": 9, "look": 9, "treat": 9, "pass": 9, "time": 9, "inject": 9, "order": 9, "overwrit": 9, "insert": 9, "sure": 9, "save": 9, "somewher": 9, "so": 9, "access": 9, "s3": 9, "gc": 9, "azur": 9, "hdf": 9, "test": 9, "system": 9, "py": 9, "task_id": 9, "run_example_notebook": 9, "tmp": 9, "ipynb": 9, "msg": 9, "ran": 9, "task": 9, "def": 9, "sb": 9, "read_notebook": 9, "url": 9, "scrap": 9, "print": 9, "f": 9, "data": 9, "return": 9, "fals": 9, "catchup": 9, "path": 9, "join": 9, "dirnam": 9, "realpath": 9, "__file__": 9, "input_notebook": 9}, "objects": {"airflow.providers": [[0, 0, 0, "-", "papermill"]], "airflow.providers.papermill": [[1, 0, 0, "-", "operators"]], "airflow.providers.papermill.operators": [[2, 0, 0, "-", "papermill"]], "airflow.providers.papermill.operators.papermill": [[2, 1, 1, "", "NoteBook"], [2, 1, 1, "", "PapermillOperator"]], "airflow.providers.papermill.operators.papermill.NoteBook": [[2, 2, 1, "", "meta_schema"], [2, 2, 1, "", "parameters"], [2, 2, 1, "", "type_hint"]], "airflow.providers.papermill.operators.papermill.PapermillOperator": [[2, 3, 1, "", "execute"], [2, 2, 1, "", "supports_lineage"], [2, 2, 1, "", "template_fields"]], "tests.system.providers": [[5, 0, 0, "-", "papermill"]], "tests.system.providers.papermill": [[3, 0, 0, "-", "example_papermill"], [4, 0, 0, "-", "example_papermill_verify"]], "tests.system.providers.papermill.example_papermill": [[3, 4, 1, "", "DAGRUN_TIMEOUT"], [3, 4, 1, "", "DAG_ID"], [3, 4, 1, "", "ENV_ID"], [3, 4, 1, "", "SCHEDULE_INTERVAL"], [3, 4, 1, "", "START_DATE"], [3, 4, 1, "", "run_this"], [3, 4, 1, "", "test_run"]], "tests.system.providers.papermill.example_papermill_verify": [[4, 4, 1, "", "DAGRUN_TIMEOUT"], [4, 4, 1, "", "DAG_ID"], [4, 4, 1, "", "ENV_ID"], [4, 4, 1, "", "SCHEDULE_INTERVAL"], [4, 4, 1, "", "START_DATE"], [4, 5, 1, "", "check_notebook"], [4, 4, 1, "", "run_this"], [4, 4, 1, "", "test_run"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:attribute", "3": "py:method", "4": "py:data", "5": "py:function"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "attribute", "Python attribute"], "3": ["py", "method", "Python method"], "4": ["py", "data", "Python data"], "5": ["py", "function", "Python function"]}, "titleterms": {"airflow": [0, 1, 2, 6, 7], "provid": [0, 1, 2, 3, 4, 5, 6, 7], "papermil": [0, 1, 2, 3, 4, 5, 6, 7, 9], "subpackag": 0, "oper": [1, 2], "submodul": [1, 5], "modul": [2, 3, 4], "content": [2, 3, 4, 7], "class": 2, "test": [3, 4, 5], "system": [3, 4, 5], "example_papermil": 3, "example_papermill_verifi": 4, "function": 4, "attribut": 4, "packag": [6, 7, 8], "apach": [6, 7], "3": [6, 7], "0": [6, 7], "2": [6, 7], "1": [6, 7], "guid": 7, "refer": 7, "resourc": 7, "commit": 7, "instal": [7, 8], "requir": 7, "changelog": 7, "break": 7, "chang": 7, "featur": 7, "bug": 7, "fix": 7, "misc": 7, "from": 8, "sourc": 8, "releas": 8, "integr": 8, "verifi": 8, "pypi": 8, "usag": 9, "creat": 9, "notebook": 9, "exampl": 9, "dag": 9}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 6, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx.ext.intersphinx": 1, "sphinx": 56}})