scargo.file_generators package

Subpackages

• scargo.file_generators.clang_parser package
  • Submodules
  • scargo.file_generators.clang_parser.data_classes module
    • ArgumentDescriptor
    • ClassDescriptor
    • FunctionDescriptor
      • FunctionDescriptor.get_arg_names()
      • FunctionDescriptor.get_arg_types()
      • FunctionDescriptor.get_specifiers()
      • FunctionDescriptor.get_typed_args()
    • HeaderDescriptor
    • IncludeDescriptor
    • NamespaceDescriptor
  • scargo.file_generators.clang_parser.header_parser module
    • parse_file()
  • scargo.file_generators.clang_parser.params_extractor module
    • extract_classes()
    • extract_includes()
    • extract_namespaces()
  • Module contents

Submodules

scargo.file_generators.base_gen module

scargo.file_generators.base_gen.create_file_from_template(template_path: str, output_path: Union[Path, str], template_params: Dict[str, Any], config: Config, overwrite: bool = True) → None

Creates file using jinja template on output path, creates dirs if necessary

scargo.file_generators.base_gen.write_template(output_path: Path, template_path: str, template_params: Dict[str, Any]) → None

scargo.file_generators.cicd_gen module

scargo.file_generators.cicd_gen.generate_cicd(config: Config) → None

Generate cicd file with custom user layer

Parameters

config (Config) – target configuration

scargo.file_generators.cmake_gen module

scargo.file_generators.cmake_gen.generate_cmake(config: Config) → None

scargo.file_generators.conan_gen module

scargo.file_generators.conan_gen.conan_add_default_profile_if_missing() → None

scargo.file_generators.conan_gen.generate_conanfile(config: Config) → None

scargo.file_generators.conan_gen.generate_conanprofile(config: Config) → None

scargo.file_generators.cpp_gen module

scargo.file_generators.cpp_gen.generate_cpp(config: Config) → None

scargo.file_generators.docker_gen module

scargo.file_generators.docker_gen.generate_docker_compose(docker_path: Path, config: Config) → None

scargo.file_generators.env_gen module

scargo.file_generators.env_gen.generate_env(output_dir_path: Path, config: Config) → None

Generate .env file which is used by docker compose providing environmental variables

scargo.file_generators.mock_gen module

scargo.file_generators.mock_gen.generate_mocks(src_header: Path, config: Config) → bool

Generates mock header and implementations for specified source headers. Creates directories and CMake lists where required. :param src_header Path to source directory or header :param config

scargo.file_generators.mock_gen.get_mock_path(header_path: Path, config: Config) → Path

scargo.file_generators.readme_gen module

scargo.file_generators.readme_gen.generate_readme(config: Config) → None

Generate dirs and files

scargo.file_generators.tests_gen module

Generate cmake for test dir

scargo.file_generators.tests_gen.generate_tests(config: Config) → None

Generate dirs and files

scargo.file_generators.toml_gen module

Generate toml for scargo project

scargo.file_generators.toml_gen.generate_toml(output_file_path: Path, **values: Any) → None

_summary_

Parameters

• output_file_path (String) – path to the output .env file

• **values (Dict) – dict contains all necessary values for toml

scargo.file_generators.ut_gen module

scargo.file_generators.ut_gen.add_ut_dir_to_parent_cmake(ut_dir_path: Path) → None

scargo.file_generators.ut_gen.generate_ut(input_path: Path, config: Config, force: bool = False) → None

scargo.file_generators.vscode_gen module

scargo.file_generators.vscode_gen.generate_launch_json(vscode_path: Path, config: Config, elf_path: Path) → None

scargo.file_generators.vscode_gen.generate_vscode(vscode_path: Path, config: Config) → None

Module contents