`pyirk.script`

Command line interface for irk package

Module Contents

`create_parser`	Returns the parser object which is then evaluated in main(). This is necessary for sphinx to automatically generate the cli docs.
`main`
`process_package`
`process_mod`
`debug`	Debug function for development of core and script modules. To interactively examine modules (builtin and others) use `--interactive-session`
`create_auto_complete_file`
`insert_keys_for_placeholders`	Motivation: When mass-inserting entities, it is easier to use a placeholder instead of unique short_key. This function replaces these placeholders with adequate unique short keys.
`replace_dummy_entities_by_label`	load the module, additionally load its source, replace entities like I000[“some label”] with real entities like I7654[“some label”].
`update_test_data`	Background: see devdocs
`process_template`
`path_to_ast_container`
`get_lines_for_short_key`
`interactive_session`	Start an interactive IPython session where the (optionally) loaded mod is available under its prefix name. Also: prepare interactive pyirk-module – a namespace for experimentally creating entities.

pyirk.script.create_parser(): Returns the parser object which is then evaluated in main(). This is necessary for sphinx to automatically generate the cli docs.

pyirk.script.process_package(pkg_path: str) → Tuple[pyirk.irkloader.ModuleType, str]

pyirk.script.process_mod(path: str, prefix: str, relative_to_workdir: bool = False) → pyirk.irkloader.ModuleType

pyirk.script.debug(): Debug function for development of core and script modules. To interactively examine modules (builtin and others) use --interactive-session

pyirk.script.insert_keys_for_placeholders(modpath): Motivation: When mass-inserting entities, it is easier to use a placeholder instead of unique short_key. This function replaces these placeholders with adequate unique short keys.

pyirk.script.replace_dummy_entities_by_label(modpath): load the module, additionally load its source, replace entities like I000[“some label”] with real entities like I7654[“some label”].

pyirk.script.path_to_ast_container(mod_path: str) → pyirk.core.aux.Container

pyirk.script.interactive_session(loaded_mod, prefix): Start an interactive IPython session where the (optionally) loaded mod is available under its prefix name. Also: prepare interactive pyirk-module – a namespace for experimentally creating entities.