Package: salient
Table of ContentsSalient: A simple SQLAlchemy LinterWhat is it?Why?Simple and NaiveThe Benefits of NaiveteTrade-OffsThe NameUsageCurrent StateRequirementsContributingSalient: A simple SQLAlchemy LinterWhat is it?Salient is a rather simple, naive, even simplistic, linter for SQLAlchemy class based models.Why?I wrote this after discovering that a SA model in a project I work on had a table column that was defined once and then redefined with a different definition later in the model. I have also found that unnecessarynullable=Trueandindex=Falsecan be found all over the place.  I wrote this after discovering that a SA model in a project I work on had a table column that was defined once and then redefined with a different definition later in the model. I have also found that unnecessarynullable=Trueandindex=Falsecan be found all over the place.Simple and NaiveSalient takes few options and parses SA models in a naive manner. Salient does not currently use an AST or a finite state machine to parse source code. Rather it parses like you might with grep.The Benefits of NaiveteSalient should be simple to understand and to maintain.Trade-OffsSalient assumes a Python module contains one SA class based model, so if you have a module with multiple classes and they have column names in common you would need to separate them or not check for redefined columns. This also means that if you havenullable=Truein a module being linted outside of a column definition the linter is going to be most unhappy with you.The NameSalient comes from my abbreviating SQLAlchemy as SA and it being a linter, SAli[e]nt.UsageThe idea, and hope, is that your SA models live in their own directory separate from other source code. Salient probably won't break if it sees other source, but it was really intended to mostly look at SA models.poetry run python salient.py -rni src/app/models/*.py1 file(s) with errors were found.

examples/all_problems.py
  Redefined Columns - unoriginal_column_name:
    16: Column(Integer)
    19: Column(Boolean)
  Unnecessary nullable=True:
    17:     col_1 = Column(nullable=True)
  Unnecessary index=False:
    18:     col_2 = Column(index=False)You can run with the-hor--helpparameter for more options.usage: salient.py [-h] [-n] [-i] [-r] [--config CONFIG] [-R RECURSIVE] [-1 STOP_AFTER_FIRST_ERROR] files [files ...]

positional arguments:
  files                 files to lint

optional arguments:
  -h, --help            show this help message and exit
  -n, --nullable-true   Check for unnecessary nullable=True
  -i, --index-false     Check for unnecessary index=False
  -r, --redefined-column
                        Check for columns that are redefined.
  --config CONFIG       Load options from CONFIG FILE.
  -R, --recursive       If FILES includes directories scan those as well
  -1 STOP_AFTER_FIRST_ERROR, --stop-after-first-error STOP_AFTER_FIRST_ERROR
                        stop after first errorCurrent StateAlpha / MVPBelieved to do what it says on the tin, but YMMVNot all command line options are implemented. (help, and the three linting rules work, that is all)Doesn't recurse subdirectoriesDoesn't currently use a config file, and no environment variables have been implemented.Still has TODOs in the code. :)Mostly untested, but the most complex of the linters is tested.PRs welcome!RequirementsPython 3.8 or above.I've set the Poetry config to require Python 3.8 or above. I don't believe anything is preventing use with 3.7, but I am not opposed to throwing in a walrus here and there if it is the best way to do something.Poetry, any modern version.ContributingCode is formatted with the latest version of Black.MyPy isn't configured yet, but please use typehints. (Not everything is typehinted, but the project is a day old at the time of this writing!)New code should be tested.