Skip to content

Add type hints (PEP 484) #124

@abstract-333

Description

@abstract-333

Description

I would like to propose adding type hints PEP 484 to the ipinfo-python library.

Currently, the SDK lacks comprehensive type annotations, which limits the effectiveness of static analysis tools (like MyPy) and reduces the quality of autocompletion in modern IDEs (VS Code, PyCharm, etc.).

Benefits

Adding type hints would:

  • Improve developer experience through better IDE autocomplete
  • Enable static type checking with tools like mypy or pyright
  • Make the SDK easier to understand and maintain
  • Help detect potential bugs earlier during development

Proposal

I would like to gradually add type annotations across the public API of the SDK while keeping the changes fully backward compatible.

Contribution

If the maintainers are open to this improvement, I would be happy to work on implementing the type hints and submit a pull request.

Please let me know if this aligns with the project’s direction or if there are any guidelines you would like me to follow for the implementation.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions