conservationtechlab / dencam

Polar bear maternal den observation system.
MIT License
5 stars 2 forks source link

Linting/Documentation/Refactoring on `gui.py` #87

Closed iingram closed 2 months ago

iingram commented 2 months ago

There should be no functional changes in this PR. It is meant to only be a linting/refactoring pass on gui.py with some improvements on the docstrings as well.

kgarwoodsdzwa commented 2 months ago

functionality is the same, but pylint gave me these errors: gui.py:21:0: R0902: Too many instance attributes (17/7) (too-many-instance-attributes) gui.py:25:4: R0913: Too many arguments (6/5) (too-many-arguments) gui.py:43:8: W0201: Attribute 'window' defined outside init (attribute-defined-outside-init) gui.py:49:8: W0201: Attribute 'vid_count_text' defined outside init (attribute-defined-outside-init) gui.py:51:8: W0201: Attribute 'storage_text' defined outside init (attribute-defined-outside-init) gui.py:53:8: W0201: Attribute 'device_text' defined outside init (attribute-defined-outside-init) gui.py:55:8: W0201: Attribute 'recording_text' defined outside init (attribute-defined-outside-init) gui.py:57:8: W0201: Attribute 'time_text' defined outside init (attribute-defined-outside-init) gui.py:59:8: W0201: Attribute 'error_text' defined outside init (attribute-defined-outside-init) gui.py:61:8: W0201: Attribute 'ip_text' defined outside init (attribute-defined-outside-init) gui.py:63:8: W0201: Attribute 'solar_text' defined outside init (attribute-defined-outside-init) gui.py:73:8: W0201: Attribute 'frames' defined outside init (attribute-defined-outside-init) gui.py:124:8: W0201: Attribute 'elapsed_time' defined outside init (attribute-defined-outside-init) gui.py:206:4: R0913: Too many arguments (6/5) (too-many-arguments) gui.py:223:0: R0903: Too few public methods (1/2) (too-few-public-methods) gui.py:368:31: W0613: Unused argument 'controller' (unused-argument) gui.py:394:0: R0903: Too few public methods (1/2) (too-few-public-methods)

the only one i tried to fix was gui.py:368:31: W0613: Unused argument 'controller' (unused-argument) but upon fixing it it throws an error elsewhere due to how frame variable for all the pages requires the controller to be there, so i think it makes sense to keep it. i think these pylint things are fine but just in case we wanted to capture that they're thrown at least in my pylint version

iingram commented 2 months ago

My version of pylint was also showing these. Good that you ran it through pylint and experimented with addressing one of them but, yes, we don't want to do the more aggressive refactor to address these remaining pylint messages, at least not on this PR. We could, of course, put in lines to tell pylint to ignore at least some of these but since we don't have a pylint hook blocking anything on this repo, I venture better to keep them apparent and, perhaps, on a later issue/PR actually address them.