MITLibraries / hrqb-client
99%
main: 96%

LAST BUILD BRANCH: v1.13.0
DEFAULT BRANCH: main
Repo Added
Files 24
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst

LAST BUILD ON BRANCH IN-1240-pip-audit-and-maintenance
branch: IN-1240-pip-audit-and-maintenance
CHANGE BRANCH
x

coverage: 98.604%. Remained the same
14935503457

Pull #206

github

ghukill 
Unpin luigi and skip type checking broadly

Why these changes are being introduced:

luigi=3.5.2 introduced a litany of type checking errors
for our usage.  As such, we had luigi pinned to 3.5.1
for some time.  With the introduction of pip-audit, and
a found vulnerability for 3.5.1, and bumping python to
3.12, it was time to finally address this.

We fairly heavily extend luigi.Task and luigi.LocalTarget,
and use those base extensions throughoug the project.
Because luigi is poorly typed, even with the `luigi.mypy` module,
we had cascading type check errors.

Manually creating .pyi stubs was explored -- and it works --
but the benefit did not seem to outweigh the cost of creating
and maintaing them.  Particularly since most of this project
is luigi task boilerplate; each task, e.g. ExtractDWEmployees,
is basically just class definitions with a minimal amount of
actual business logic.  This was the appeal of luigi, and it's
why these .pyi files would be nearly doubling the codebase.

The ultimate solution feels to just skip type checking
for luigi based classes, given a) luigi is poorly typed
already, and b) the signatures are effectively the same for
each task.  IDE's will still benefit from understanding
what classes can do, but we skip linting errors.

How this addresses that need:
* Unpins luigi, resulting in install of luigi=3.6.0 at time
of this commit
* Adds explicit type checking ignores for hrqb.base.* and
hrqb.task.*
* Remove vulnerability ignore now no longer present in luigi

Side effects of this change:
* Luigi is updated, but type checking is lost for most
luigi tasks (at least temporarily)

Relevant ticket(s):
* https://mitlibraries.atlassian.net/browse/IN-1258
Pull Request #206: IN 1240 - Replace pipenv check with pip-audit and maintenance

1 of 1 new or added line in 1 file covered. (100.0%)

918 of 931 relevant lines covered (98.6%)

0.99 hits per line

Relevant lines Covered
931 RELEVANT LINES 918 COVERED LINES
0.99 HITS PER LINE
Source Files on IN-1240-pip-audit-and-maintenance

Recent builds

Builds Branch Commit Type Ran Committer Via Coverage
14935503457 IN-1240-pip-audit-and-maintenance Unpin luigi and skip type checking broadly Why these changes are being introduced: luigi=3.5.2 introduced a litany of type checking errors for our usage. As such, we had luigi pinned to 3.5.1 for some time. With the introduction of pip-audit, ... Pull #206 ghukill github
98.6
14934510833 IN-1240-pip-audit-and-maintenance Bump python 3.12 Why these changes are being introduced: This CLI was stuck on python 3.11 for awhile while untangling some mypy linting errors. Turns out it was luigi >= 3.5.2 that presented the issues. With luigi still pinned, we can perform... Pull #206 ghukill github
98.6
14932844083 IN-1240-pip-audit-and-maintenance Replace pipenv check with pip-audit Why these changes are being introduced: As of pipenv 2025.0.1 the use of `pipenv check` would throw an error, indicating that the library `safety` was not installed. It worked to run `pipenv check --auto-insta... Pull #206 ghukill github
98.6
See All Builds (335)