API Reference

companies_house_codegen

Modules:

• argument –

  The argument parser used by main.py

• codegen –

  Code formatting and generation

• constants –

  Important constants for related to codegen

• types –

  Typings for codegen.

• utils –

  Utilities for codegen.

Functions:

• main –

  The command-line interface for companies_house_codegen programme.

• void_main –

  The command-line interface for companies_house_codegen programme.

logger module-attribute

logger = getLogger(__name__)

Logger for companies_house_codegen

main

main(args: Sequence[str] | None = None) -> ExitCode

The command-line interface for companies_house_codegen programme.

Parameters:

• args

  (Sequence[str] | None, default: None ) –

  sequence of command line arguements. If not passed, gets commandline arguments from sys.argv

Returns:

• exit_code ( int ) –

  An integer representing how the programme exited.

See Also

ExitCode: Exit code for the main function

void_main

void_main(args: Sequence[str] | None = None) -> None

The command-line interface for companies_house_codegen programme.

Parameters:

• args

  (Sequence[str] | None, default: None ) –

  sequence of command line arguements. If not passed, gets commandline arguments from sys.argv