Skip to content

File: jsoncfg.py

Role: Python Source Code

Path: mosheh.types

To ensure the correct type annotation of the default config file mosheh.json this file invokes the typing.TypedDict powers for leading this mission.

The config JSON itself is divided at 2 parts: Documentation and IO:

  • Documentation: handles the project's data and final documentation configuration
  • IO: handles the input and output infos, such as output path and codebase root

The idea here is to use TypedDict as a typing alias plus contract - kinda.

Imports

import TypedDict

Path: typing

Category: native

Snippet
Python
from typing import TypedDict

Consts

NO CONSTANT DEFINED HERE

Classes

class DocumentationJSON

Parents: TypedDict

Decorators: None

Kwargs: None

Docstring

Typed-Dict class to ensure right typing for config file's doc section.

Snippet
Python
class DocumentationJSON(TypedDict):
    """Typed-Dict class to ensure right typing for config file's doc section."""
    projectName: str
    repoName: str
    repoUrl: str
    editUri: str
    siteUrl: str
    logoPath: str | None
    readmePath: str | None
    codebaseNavPath: str

class IOJSON

Parents: TypedDict

Decorators: None

Kwargs: None

Docstring

Typed-Dict class to ensure right typing for config file's IO section.

Snippet
Python
class IOJSON(TypedDict):
    """Typed-Dict class to ensure right typing for config file's IO section."""
    rootDir: str
    outputDir: str

class DefaultJSON

Parents: TypedDict

Decorators: None

Kwargs: None

Docstring

Typed-Dict class to ensure right typing for config file itself.

Snippet
Python
class DefaultJSON(TypedDict):
    """Typed-Dict class to ensure right typing for config file itself."""
    documentation: DocumentationJSON
    io: IOJSON

Functions

NO FUNCTION DEFINED HERE

Assertions

NO ASSERT DEFINED HERE