Library Reference¶

Contents:

• mash
  • cli module
    • generate_help()
    • main()
    • run()
    • setup()
    • step()
    • toolbar()
  • doc_inference module
    • generate_docs()
    • generate_parameter_docs()
    • infer_args()
    • infer_default_and_non_default_args()
    • infer_signature()
    • infer_synopsis()
  • filesystem package
    • Submodules
    • filesystem.discoverable module
      • Usage
      • Discoverable
        • Discoverable.discover()
        • Discoverable.load()
        • Discoverable.observe()
        • Discoverable.observe_child_fields()
        • Discoverable.reset()
        • Discoverable.save_observed_value()
        • Discoverable.show()
        • Discoverable.snapshot()
        • Discoverable.undiscover()
      • discover_using_cls()
      • infer_defaults()
      • infer_initial_value_key()
      • observe()
    • filesystem.filesystem module
      • FileSystem
        • FileSystem.append()
        • FileSystem.cd()
        • FileSystem.cd_option()
        • FileSystem.cd_step()
        • FileSystem.cd_up()
        • FileSystem.copy()
        • FileSystem.cp()
        • FileSystem.cwd
        • FileSystem.foreach()
        • FileSystem.full_path
        • FileSystem.get()
        • FileSystem.home
        • FileSystem.in_home()
        • FileSystem.infer_key_name()
        • FileSystem.init_home()
        • FileSystem.init_states()
        • FileSystem.ll()
        • FileSystem.load()
        • FileSystem.ls()
        • FileSystem.mv()
        • FileSystem.path
        • FileSystem.rm()
        • FileSystem.semantic_path
        • FileSystem.set()
        • FileSystem.show()
        • FileSystem.simulate_cd()
        • FileSystem.snapshot()
        • FileSystem.tree()
      • Option
        • Option.default
        • Option.home
        • Option.root
        • Option.stay
        • Option.switch
        • Option.up
        • Option.upup
        • Option.upupup
        • Option.verify()
      • cd()
    • filesystem.scope module
      • Scope
        • Scope.asdict()
        • Scope.keys()
        • Scope.update()
      • show()
    • filesystem.view module
      • View
        • View.copy()
        • View.cp()
        • View.down()
        • View.get()
        • View.infer_index()
        • View.ls()
        • View.mv()
        • View.path
        • View.rm()
        • View.set()
        • View.trace
        • View.tree
        • View.up()
      • ViewError
      • verify_directory()
    • Module contents
  • io_util module
    • ArgparseWrapper
    • add_default_args()
    • allow_all_args()
    • bold()
    • catch_output()
    • check_output()
    • confirm()
    • debug()
    • find_argument()
    • has_argument()
    • has_output()
    • log()
    • log_once()
    • print_shell_ready_signal()
    • python_is_run_in_test_mode()
    • read_file()
    • read_files()
    • read_line()
    • run_subprocess()
    • set_verbosity()
    • terminal_size()
    • verbosity()
    • warn()
  • object_parser package
    • Submodules
    • object_parser.errors module
      • BuildError
      • BuildErrors
      • ErrorMessages
        • ErrorMessages.invalid_key_format()
        • ErrorMessages.missing_mandatory_key()
        • ErrorMessages.no_type_annotations()
        • ErrorMessages.unexpected_key()
      • SpecError
      • SpecErrors
      • to_string()
    • object_parser.factory module
      • Factory
        • Factory.build()
        • Factory.build_instance()
        • Factory.error_prefix
        • Factory.parent_path
        • Factory.parse_value()
        • Factory.verify_key_format()
      • JSONFactory
        • JSONFactory.build_enum()
        • JSONFactory.build_field()
        • JSONFactory.build_fields()
        • JSONFactory.build_from_dict()
        • JSONFactory.build_generic_Dict()
        • JSONFactory.build_instance()
        • JSONFactory.build_list()
        • JSONFactory.build_object()
      • build()
    • object_parser.oas module
      • K
        • K.components
        • K.doc
        • K.props
        • K.schemas
      • OAS
        • OAS.add_array()
        • OAS.components
        • OAS.extend()
      • V
        • V.ref()
      • has_known_type()
      • infer_oas_type()
      • oas_component()
      • oas_ref()
      • path_create()
    • object_parser.object_parser module
      • find_synonym()
      • parse_field_key()
      • parse_field_keys()
      • verify_key_format()
    • object_parser.object_parser_standards module
      • A
        • A.x
        • A.y
        • A.z
      • B
        • B.bottom
        • B.left
        • B.right
        • B.top
      • C
        • C.a
        • C.b
        • C.x
        • C.y
        • C.z
      • dictionary_mapping()
      • differencing()
    • Module contents
  • progress_bar module
    • show()
  • server package
    • Subpackages
      • server.domain package
        • Submodules
        • server.domain.css module
          • Border
            • Border.color
            • Border.rounded
            • Border.style
            • Border.width
          • BorderStyle
            • BorderStyle.dashed
            • BorderStyle.dotted
            • BorderStyle.double
          • Document
            • Document.body
            • Document.footer
            • Document.header
          • Element
            • Element.border
            • Element.margin
          • Margin
            • Margin.bottom
            • Margin.left
            • Margin.right
            • Margin.top
          • RGBColor
            • RGBColor.blue
            • RGBColor.green
            • RGBColor.red
          • generate_style()
        • server.domain.user module
          • RawUser
            • RawUser.email
            • RawUser.name
          • generate_user()
          • init_users()
        • Module contents
      • server.routes package
        • Submodules
        • server.routes.default module
          • init()
          • url()
        • server.routes.documents module
          • init()
        • server.routes.users module
          • init()
        • Module contents
    • Submodules
    • server.repository module
      • Repository
        • Repository.read()
      • create_user()
    • server.server module
      • init()
      • init_routes()
    • Module contents
  • shell package
    • Subpackages
      • shell.ast package
        • Submodules
        • shell.ast.conditions module
          • Conditions
          • Condition
          • Else
            • Else.run()
          • ElseCondition
          • ElseIf
            • ElseIf.run()
          • ElseIfThen
            • ElseIfThen.run()
          • If
            • If.run()
          • IfThen
            • IfThen.run()
          • IfThenElse
            • IfThenElse.run()
          • Then
            • Then.run()
        • shell.ast.function_definition module
          • FunctionDefinition
            • FunctionDefinition.data
            • FunctionDefinition.define_function()
            • FunctionDefinition.run()
          • InlineFunctionDefinition
            • InlineFunctionDefinition.run()
        • shell.ast.infix module
          • Assign
            • Assign.key
            • Assign.run()
            • Assign.value
          • BashPipe
            • BashPipe.run()
          • BinaryExpression
            • BinaryExpression.run()
          • Infix
            • Infix.data
          • LogicExpression
            • LogicExpression.run()
          • Map
            • Map.map()
            • Map.run()
          • Pipe
            • Pipe.run()
        • shell.ast.node module
          • Indent
            • Indent.run()
          • Math
            • Math.eval()
            • Math.eval_terms()
            • Math.run()
          • Node
            • Node.run()
            • Node.values
          • Return
            • Return.run()
          • Shell
            • Shell.run()
        • shell.ast.nodes module
          • Nodes
          • Node
          • Lines
            • Lines.data
            • Lines.run()
          • Nodes
            • Nodes.data
            • Nodes.extend()
            • Nodes.values
          • Terms
            • Terms.run()
        • shell.ast.set_definition module
          • SetDefinition
            • SetDefinition.apply()
            • SetDefinition.parse_result()
            • SetDefinition.run()
          • merge()
        • shell.ast.term module
          • Term
          • Method
            • Method.run()
          • NestedTerm
            • NestedTerm.run()
            • NestedTerm.values
          • NestedVariable
            • NestedVariable.expand_variable()
          • PositionalVariable
            • PositionalVariable.run()
          • PythonData
          • Quoted
            • Quoted.run()
          • Term
            • Term.expand_variable()
            • Term.run()
            • Term.run_terms()
          • Variable
            • Variable.run()
          • Word
        • Module contents
      • shell.grammer package
        • Submodules
        • shell.grammer.literals module
        • shell.grammer.parse_functions module
          • dataclass_to_string()
          • dict_to_string()
          • expand_variables()
          • expand_variables_inline()
          • filter_comments()
          • indent_width()
          • inline_indent_with()
          • list_to_string()
          • quote_items()
          • quote_return_value()
          • to_bool()
          • to_string()
        • shell.grammer.parser module
          • parse()
        • shell.grammer.tokenizer module
          • main()
          • tokenize()
        • Module contents
    • Submodules
    • shell.base module
      • BaseShell
        • BaseShell.add_functions()
        • BaseShell.add_special_function()
        • BaseShell.do_bool()
        • BaseShell.do_env()
        • BaseShell.do_float()
        • BaseShell.do_int()
        • BaseShell.do_not()
        • BaseShell.do_reload()
        • BaseShell.do_save()
        • BaseShell.do_undo()
        • BaseShell.do_unset()
        • BaseShell.get_method()
        • BaseShell.init_current_scope()
        • BaseShell.is_function()
        • BaseShell.is_hidden_function()
        • BaseShell.is_inline_function()
        • BaseShell.is_special_function()
        • BaseShell.last_method()
        • BaseShell.load_session()
        • BaseShell.postcmd()
        • BaseShell.remove_functions()
        • BaseShell.reset_locals()
        • BaseShell.run_commands()
        • BaseShell.run_hidden_function()
        • BaseShell.run_special_function()
        • BaseShell.save_session()
        • BaseShell.try_load_session()
      • filter_private_keys()
      • is_private()
      • is_public()
    • shell.cmd2 module
      • Cmd2
        • Cmd2.completenames()
        • Cmd2.completenames_options
        • Cmd2.default()
        • Cmd2.do_E()
        • Cmd2.do_cat()
        • Cmd2.do_echo()
        • Cmd2.do_exit()
        • Cmd2.do_fail()
        • Cmd2.do_flatten()
        • Cmd2.do_print()
        • Cmd2.do_println()
        • Cmd2.do_range()
        • Cmd2.do_shell()
        • Cmd2.do_source()
        • Cmd2.ignore_invalid_syntax
        • Cmd2.intro
        • Cmd2.mode
        • Cmd2.none()
        • Cmd2.onecmd()
        • Cmd2.onecmd_inner()
        • Cmd2.onecmd_prehook()
        • Cmd2.onecmd_raw()
        • Cmd2.prompt
        • Cmd2.use_mode()
      • Mode
        • Mode.COMPILE
        • Mode.REPL
      • cat_file()
      • run()
      • run_command()
      • run_commands_from_file()
      • run_interactively()
    • shell.errors module
      • ShellError
      • ShellPipeError
      • ShellSyntaxError
    • shell.function module
      • InlineFunction
        • InlineFunction.args
        • InlineFunction.command
        • InlineFunction.func_name
        • InlineFunction.inner
        • InlineFunction.line_indent
        • InlineFunction.multiline
      • ShellFunction
        • ShellFunction.handle_exception()
      • scope()
    • shell.shell module
      • Shell
        • Shell.do_map()
        • Shell.do_math()
        • Shell.foldr()
        • Shell.keyboard_interrupt()
        • Shell.onecmd_inner()
        • Shell.parse()
        • Shell.run_commands()
      • add_cli_args()
      • all_commands()
      • build()
      • has_input()
      • main()
      • read_stdin()
      • run_command()
      • set_cli_args()
      • set_completions()
      • set_functions()
      • setup()
      • sh_to_py()
    • shell.with_filesystem module
      • ShellWithFileSystem
        • ShellWithFileSystem.add_cd_alias()
        • ShellWithFileSystem.cd()
        • ShellWithFileSystem.complete_cd()
        • ShellWithFileSystem.default_method()
        • ShellWithFileSystem.foreach()
        • ShellWithFileSystem.get()
        • ShellWithFileSystem.init_home()
        • ShellWithFileSystem.init_shell()
        • ShellWithFileSystem.new()
        • ShellWithFileSystem.pwd()
        • ShellWithFileSystem.set()
        • ShellWithFileSystem.set_cd_aliases()
        • ShellWithFileSystem.set_shell_completions()
        • ShellWithFileSystem.unset_cd_aliases()
        • ShellWithFileSystem.update_prompt()
        • ShellWithFileSystem.use()
    • Module contents
  • subshell module
    • handle_user_input()
    • main()
    • read_output()
    • run()
    • verify_promt_is_ready()
  • util module
    • DataClassHelper
      • DataClassHelper.ensure_field()
      • DataClassHelper.set_field()
      • DataClassHelper.verify_context_key()
    • Encoder
      • Encoder.default()
      • Encoder.serialize_dataclass()
    • accumulate_list()
    • append_list()
    • call()
    • concat()
    • concat_empty_container()
    • constant()
    • crop()
    • dataclass_to_string()
    • decorate()
    • deserialize_dataclass()
    • deserialize_dataclasses()
    • equals()
    • extend()
    • extract_exception()
    • find_fuzzy_matches()
    • find_prefix_matches()
    • first()
    • flip()
    • for_all()
    • for_any()
    • for_each()
    • glob()
    • group()
    • hamming()
    • has_annotations()
    • has_method()
    • identity()
    • infer_dependencies()
    • infer_inner_cls()
    • is_Dict()
    • is_Dict_or_List()
    • is_List()
    • is_alpha()
    • is_alphanumerical()
    • is_callable()
    • is_digit()
    • is_enum()
    • is_globbable()
    • is_valid_method_name()
    • lazy_map()
    • list_prefix_matches()
    • match_words()
    • none()
    • not_equals()
    • omit_prefixes()
    • partial_no_args()
    • partial_simple()
    • quote()
    • quote_all()
    • removeprefix()
    • rename()
    • split()
    • split_prefixes()
    • split_sequence()
    • split_tips()
    • take()
    • translate_items()
    • use_recursion_limit()
  • webtools package
    • Submodules
    • webtools.html_table module
      • generate()
      • main()
      • parse()
      • parse_cell()
      • parse_column()
      • parse_row()
      • render()
      • render_table_body()
      • render_table_head()
    • webtools.html_table_data module
      • HTMLTableData
        • HTMLTableData.max_row_height
        • HTMLTableData.parameters
        • HTMLTableData.rows
      • Markdown
        • Markdown.parse_value()
      • Parameters
        • Parameters.headings
      • Row
        • Row.height
        • Row.row
      • parse_json()
    • webtools.parallel module
      • asynchronous()
      • main()
      • new_event_loop()
      • run()
      • show_status()
      • simple_custom_func()
      • some_custom_func()
      • try_task()
      • worker()
    • webtools.parallel_requests module
      • compute()
      • echo()
      • echo_offline()
      • generate_()
      • get()
      • parse_response_()
      • post()
      • randomize_()
      • run_compute_pipeline()
      • sleep()
      • test_compute_pipeline()
      • to_float_()
      • to_int_()
      • to_str_()
    • webtools.pipeline module
      • Buffer
        • Buffer.full()
      • Combiner
        • Combiner.process_item()
        • Combiner.ready_to_process()
      • Distributer
        • Distributer.append()
        • Distributer.extend()
      • Pipeline
        • Pipeline.init_processors()
      • Processor
        • Processor.append()
        • Processor.clear()
        • Processor.extend()
        • Processor.from_function()
        • Processor.process()
        • Processor.process_item()
        • Processor.ready_to_process()
      • PushPull
        • PushPull.append()
        • PushPull.extend()
        • PushPull.in_queue
        • PushPull.init_resources()
        • PushPull.n_processors
        • PushPull.out_queue
        • PushPull.process()
        • PushPull.process_buffer()
        • PushPull.process_item()
        • PushPull.start_resources()
      • Resource
        • Resource.delivery_queues
        • Resource.demand_input()
        • Resource.demand_queues
        • Resource.in_queue
        • Resource.out_queue
        • Resource.process()
        • Resource.processor
        • Resource.put()
        • Resource.start()
        • Resource.strategy
        • Resource.wait_for_input_demand()
      • Strategy
        • Strategy.constant
        • Strategy.pull
        • Strategy.push
      • constant_()
      • duplicate_()
      • identity_()
    • webtools.verify_server module
      • VerificationException
      • connect()
      • infer_protocol_and_port_from_hostname()
      • main()
      • parse_hostname()
      • parse_port()
      • parse_url()
      • resolve()
      • resolve_then_connect()
    • Module contents