Skip to content

split seqbox_utils.py into smaller files - #12

Open
rpetit3 wants to merge 3 commits into
flashton2003:adjustments_for_corefrom
rpetit3:rp3-split-utils
Open

split seqbox_utils.py into smaller files#12
rpetit3 wants to merge 3 commits into
flashton2003:adjustments_for_corefrom
rpetit3:rp3-split-utils

Conversation

@rpetit3

@rpetit3 rpetit3 commented Dec 10, 2023

Copy link
Copy Markdown

This PR is a work-in-progress and comments and/or suggestions are expected.

  1. seqbox_utils.py was split into three smaller files
    a. scripts/utils/check.py' includes all the functions for "checking" things b. scripts/utils/db.pyincludes all functions related to working with the database c.scripts/utils/generic.py' includes functions that are rather generic (e.g. reading files)
  2. Added doc strings for each function in each of these files
  3. Adjusted the width to in most cases not exceed column 120 (mostly just for readability)
  4. Organized functions in alphabetical order for each file
    a. Will make finding easier and works nicely with Github code viewer and IDE outline
    b. scripts/utils/db.py was sorted based on the Model functions were associated with
  5. Updated sourcing in seqbox_cmd.py and the tests
  6. Where noticed altered Python code to follow PEP standards
    a. Ex. a is False --> not a
    b. Ex. if a is True --> if a

What needs to be done still:

  1. Verify imports (e.g. from scripts.utils.db import function) is working.

I modeled this after the apps.model structure. Just need to verify Flask follows the same for the scripts folder.

  1. Verify seqbox_cmd.py and the tests still work.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant