Using pre-commit

[colin0brass]

Using pre-commit seems like a good idea to catch problems before they hit other people, but I am certainly not used to working with it yet and it does seem quite hard work so far.

Can it be improved, will we learn and get used to it, or is it going to get in the way and we should get rid of it?

pip install -r requirements-dev.txt
pre-commit install

[colin0brass]

Doing commit now:

It runs pre-commit
Pop-up says: "Git: trim trailing whitespace.......Passed"

Clicking on "Show output" it shows lots of pre-commit stages Passed, but then "black" has Failed
It says reformatted gedcom-to-map/gui/processors/gedcom_loader.py
"All done!" "1 file reformatted" etc.

Going back to the VS Studio sidebar for Source Control, Changes, I see that indeed there are new changes in "gedcom_loader.py"
A couple of multi-line assignments were put back as single line

I added them to the git checkin and tried the Commit again

This time it worked!

[D-Jeffrey]

I was in this loop. For my configuration, it needs to include venv to get the package includes. I tried using language: system and run a python script as an include. I tried using language: python and running pytest directly. I tried using a shell script to include the venv. I tried using python which selected the os type of and then included the venv and run python. I tried using dependent and listing all the packages.

I tried a simple edit on kml_exporter.py and push...

> git -c user.useConfigOnly=true commit --quiet --allow-empty-message --file -
trim trailing whitespace.................................................Passed
fix end of files.........................................................Passed
check yaml...........................................(no files to check)Skipped
check for added large files..............................................Passed
check for merge conflicts................................................Passed
check for case conflicts.................................................Passed
mixed line ending........................................................Failed
- hook id: mixed-line-ending
- exit code: 1

gedcom-to-map/render/kml1/kml_exporter.py: fixed mixed line endings

black....................................................................Failed
- hook id: black
- files were modified by this hook

reformatted gedcom-to-map\render\kml1\kml_exporter.py

All done! \u2728 \U0001f370 \u2728
1 file reformatted.

flake8...................................................................Passed
pytest (fast tests only).................................................Failed
- hook id: pytest-fast
- exit code: 2

=================================== ERRORS ====================================
___ ERROR collecting gedcom-to-map/render/tests/test_statistics_markdown.py ___
ImportError while importing test module 'C:\Users\darre\source\repos\gedcom-to-visualmap\gedcom-to-map\render\tests\test_statistics_markdown.py'.
Hint: make sure your test modules/packages have valid Python names.
Traceback:
..\..\..\AppData\Local\Programs\Python\Python312\Lib\importlib\__init__.py:90: in import_module
    return _bootstrap._gcd_import(name[level:], package, level)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
gedcom-to-map\render\tests\test_statistics_markdown.py:8: in <module>
    from render.statistics_markdown import (
gedcom-to-map\render\__init__.py:66: in <module>
    from .summary import (
gedcom-to-map\render\summary.py:15: in <module>
    import pandas as pd
E   ModuleNotFoundError: No module named 'pandas'
_________ ERROR collecting gedcom-to-map/render/tests/test_summary.py _________
ImportError while importing test module 'C:\Users\darre\source\repos\gedcom-to-visualmap\gedcom-to-map\render\tests\test_summary.py'.
Hint: make sure your test modules/packages have valid Python names.
Traceback:
..\..\..\AppData\Local\Programs\Python\Python312\Lib\importlib\__init__.py:90: in import_module
    return _bootstrap._gcd_import(name[level:], package, level)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
gedcom-to-map\render\tests\test_summary.py:3: in <module>
    import pandas as pd
E   ModuleNotFoundError: No module named 'pandas'
______ ERROR collecting gedcom-to-map/tests/test_gui_file_operations.py _______
ImportError while importing test module 'C:\Users\darre\source\repos\gedcom-to-visualmap\gedcom-to-map\tests\test_gui_file_operations.py'.
Hint: make sure your test modules/packages have valid Python names.
Traceback:
..\..\..\AppData\Local\Programs\Python\Python312\Lib\importlib\__init__.py:90: in import_module
    return _bootstrap._gcd_import(name[level:], package, level)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
gedcom-to-map\tests\test_gui_file_operations.py:24: in <module>
    from gui.actions.file_operations import FileOpener
gedcom-to-map\gui\actions\__init__.py:12: in <module>
    from .visual_map_actions import VisualMapActions, Geoheatmap, gedcom_to_map
gedcom-to-map\gui\actions\visual_map_actions.py:17: in <module>
    from render.summary import SummaryReportConfig, generate_summary_reports
gedcom-to-map\render\__init__.py:66: in <module>
    from .summary import (
gedcom-to-map\render\summary.py:15: in <module>
    import pandas as pd
E   ModuleNotFoundError: No module named 'pandas'
=========================== short test summary info ===========================
ERROR gedcom-to-map/render/tests/test_statistics_markdown.py
ERROR gedcom-to-map/render/tests/test_summary.py
ERROR gedcom-to-map/tests/test_gui_file_operations.py
!!!!!!!!!!!!!!!!!!! Interrupted: 3 errors during collection !!!!!!!!!!!!!!!!!!!
8 deselected, 3 errors in 5.84s

pytest (attribute consistency).......................(no files to check)Skipped

[D-Jeffrey]

^ that is weird.