Uploaded image for project: 'Data Management'
  1. Data Management
  2. DM-9919

Document recommended flake8 exclusions

    XMLWordPrintable

    Details

      Description

      Via DM-9879 we've found some useful exclude paths for the flake8 configuration:

      [flake8]
      		 
      max-line-length = 79
      		 
      ignore = E133, E226, E228, N802, N803
      		 
      exclude =
      		 
        bin,
      		 
        doc,
      		 
        **/*/__init__.py,
      		 
        **/*/version.py,
      		 
        tests/.tests/

      This can be added to the Python Style Guide at https://developer.lsst.io/coding/python_style_guide.html#flake8-configuration-files

        Attachments

          Issue Links

          relates to

          Epic - Created by Jira Software - do not edit or delete. Issue type for a big user story that needs to be broken down. DM-7600 Pytest and Flake8 integration with CI and sconsUtils

          • Done

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-9879 validate_base coding style and unittest cleanups

          • Done

            Activity

            Ascending order - Click to sort in descending order
            Hide
            Permalink
            jsick Jonathan Sick added a comment -

            Draft at: https://developer.lsst.io/v/DM-9919/coding/python_style_guide.html#flake8-configuration-files

            See PR for justification.

            One decision decision is whether justification for each ignored path should be added to the DM Python Style Guide, or whether it is sufficiently self-explanatory.

            Show
            jsick Jonathan Sick added a comment - Draft at: https://developer.lsst.io/v/DM-9919/coding/python_style_guide.html#flake8-configuration-files See PR for justification. One decision decision is whether justification for each ignored path should be added to the DM Python Style Guide, or whether it is sufficiently self-explanatory.
            Hide
            Permalink
            ktl Kian-Tat Lim added a comment -

            Looks good, but I do think putting the brief rationale from the commit comment in the text itself would be a good idea.

            Show
            ktl Kian-Tat Lim added a comment - Looks good, but I do think putting the brief rationale from the commit comment in the text itself would be a good idea.
            Hide
            Permalink
            jsick Jonathan Sick added a comment -

            I agree. I added a bit of text that's useful but not intrusive.

            Show
            jsick Jonathan Sick added a comment - I agree. I added a bit of text that's useful but not intrusive.

              People

              Assignee:
              jsick Jonathan Sick
              Reporter:
              jsick Jonathan Sick
              Reviewers:
              Kian-Tat Lim
              Watchers:
              John Parejko, Jonathan Sick, Kian-Tat Lim
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  Jenkins

                  No builds found.