Internals

Concourse Tools contains a number of internal utility functions which may be useful for developers.

• Parsing
  • JSON Parsing
    • parse_check_payload()
    • parse_in_payload()
    • parse_out_payload()
    • parse_metadata()
  • JSON Formatting
    • format_check_output()
    • format_in_out_output()
    • format_metadata()
• Command Line
  • CLI
    • invoke()
    • register()
    • register_function()
    • print_help()
    • print_version()
  • CLICommand
    • invoke()
    • parse_args()
    • print_help()
    • usage_string()
    • from_function()
  • Docstring
    • from_object()
    • from_string()
  • Parameters
    • PositionalArgument
    • Option
    • FlagOption
    • Parameter
      • long_alias
      • short_alias
      • aliases
      • add_to_parser()
      • yield_from_function()
• Dockertools
  • create_script_file()
  • Dockerfile
    • Instruction
      • to_string()
    • Comment
      • to_string()
    • Dockerfile
      • new_instruction_group()
      • write_to_file()
      • to_string()
  • Dockerfile Instructions
    • CopyInstruction
    • EntryPointInstruction
    • EnvInstruction
    • FromInstruction
    • RunInstruction
    • MultiLineRunInstruction
    • WorkDirInstruction
  • Dockerfile Mounts
    • Mount
      • to_string()
      • to_dict()
    • SecretMount
• Dynamic Importing
  • import_single_class_from_module()
  • import_classes_from_module()
  • file_path_to_import_path()
  • import_py_file()
  • edit_sys_path()
• Main Scripts
  • check_main()
  • in_main()
  • out_main()
• Typing
  • Concourse Types
    • ResourceConfig
    • Params
    • Metadata
    • MetadataPair
    • VersionConfig
  • Type Vars
    • VersionT
    • TypedVersionT
    • SortableVersionT
  • Protocols
    • VersionProtocol
    • TypedVersionProtocol
    • SortableVersionProtocol