Skip to content

Enhancement: Add type hinting to code base #123

@damian-romero

Description

@damian-romero

Summary
Following current Python best practices and following our plan for CI testing, we will add type hints to the codebase. Doing so will make the code more readable and easier to debug.

Objectives

Proposal

Add type hints to all functions/classes where it makes sense. For example:

def dict_load(config_file, vargs=None):
# -->
def dict_load(config_file: str, vargs=None):

Testing notes

Test using linter and CI.

Additional notes

We may want to migrate to Python 3.9 at this point for its type hinting capabilities that don't require importing typing for things such as dict[str, int]

Implemented in: TBD

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or requestp2Tier-2 issues that require addressing but not imminentpep8PEP8 compliance, formatting

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions