inmanta / inmanta/std

Add py.typed

Open
#628 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
0
Forks
6
Avg merge
12h 25m
Merged PRs (30d)
5

Description

We should add a py.typed file

However, this may cause issues

Know issues:

  1. the result of regex_string is intended to be used as a type (for pydantic) but it is not typed as a type
inmanta_plugins/connect/configuration.py:626: note: See https://mypy.readthedocs.io/en/stable/common_issues.html#variables-vs-type-aliases
inmanta_plugins/connect/configuration.py:637: error: Variable "inmanta_plugins.config.const.InmantaTemplatePath" is not valid as a type  [valid-type]
  • This should be well coordinated with solutions team
  • enabling mypy baseline on all solutions repos may be required
  • If done, add similar ticket to lsm

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the proposed py.typed addition and the mypy errors in inmanta_plugins/connect/configuration.py around lines 626 and 637. Coordinate with the solutions team about the regex_string and InmantaTemplatePath typing issues, then assess whether a mypy baseline is needed across solutions repositories and whether a similar LSM ticket is required. Done means these coordination items and typing consequences are resolved.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.