The MkInit Module

A tool to autogenerate explicit top-level imports

Read the docs	https://mkinit.readthedocs.io
Github	https://github.com/Erotemic/mkinit
Pypi	https://pypi.org/project/mkinit

Autogenerates __init__.py files statically and dynamically. To use the static version simply pip install and run the mkinit command with the directory corresponding to the package.

The main page for this project is: https://github.com/Erotemic/mkinit

Quick Start

Install mkinit via pip install mkinit. Then run:

MOD_INIT_PATH=path/to/repo/module/__init__.py
mkinit "$MOD_INIT_PATH"

This will display autogenerated code that exposes all top-level imports. Use the --diff option to check differences with existing code, and add the -w flag to write the result.

Package Layout

• mkinit
  • mkinit package
    • Subpackages
      • mkinit.util package
        • Submodules
          • mkinit.util.orderedset module
          • mkinit.util.util_diff module
            • difftext()
            • highlight_code()
          • mkinit.util.util_import module
            • _parse_static_node_value()
            • _extension_module_tags()
            • _static_parse()
            • _platform_pylib_exts()
            • _syspath_modname_to_modpath()
            • modname_to_modpath()
            • normalize_modpath()
            • modpath_to_modname()
            • split_modpath()
        • Module contents
    • Submodules
      • mkinit.__main__ module
        • main()
      • mkinit._tokenize module
        • ISTERMINAL()
        • ISNONTERMINAL()
        • ISEOF()
        • tokenize()
        • generate_tokens()
        • detect_encoding()
        • untokenize()
        • TokenInfo
          • TokenInfo.exact_type
      • mkinit.dynamic_mkinit module
        • dynamic_init()
        • _indent()
        • _excecute_imports()
        • _execute_fromimport_star()
        • _make_initstr()
        • _make_module_header()
        • _make_imports_str()
        • _make_fromimport_str()
        • _find_local_submodule_names()
        • _autogen_write()
      • mkinit.formatting module
        • _ensure_options()
        • _insert_autogen_text()
        • _find_insert_points()
        • _indent()
        • _initstr()
        • _make_lazy_boilerplate()
        • codeblock()
        • _make_our_lazy_boilerplate()
        • _make_imports_str()
        • _packed_rhs_text()
        • _make_fromimport_str()
      • mkinit.static_analysis module
        • _parse_static_node_value()
        • parse_static_value()
        • package_modpaths()
        • is_balanced_statement()
        • _locate_ps1_linenos()
        • _workaround_16806()
      • mkinit.static_mkinit module
        • autogen_init()
        • static_init()
      • mkinit.top_level_ast module
        • TopLevelVisitor
          • TopLevelVisitor._register()
          • TopLevelVisitor._unregister()
          • TopLevelVisitor.parse()
          • TopLevelVisitor.visit_FunctionDef()
          • TopLevelVisitor.visit_AsyncFunctionDef()
          • TopLevelVisitor.visit_ClassDef()
          • TopLevelVisitor.visit_Assign()
          • TopLevelVisitor.visit_AnnAssign()
          • TopLevelVisitor.visit_If()
          • TopLevelVisitor.visit_Try()
          • TopLevelVisitor.visit_TryExcept()
          • TopLevelVisitor.visit_Delete()
    • Module contents
      • The MkInit Module
        • Quick Start
      • autogen_init()
      • dynamic_init()
      • static_init()

Indices and tables

• Index

• Module Index

• Search Page