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

Patch flake8 to support W505

    XMLWordPrintable

    Details

    • Type: Story
    • Status: Invalid
    • Resolution: Done
    • Fix Version/s: None
    • Component/s: Third Party Software
    • Labels:
      None
    • Story Points:
      3
    • Sprint:
      Arch 2018-11-26
    • Team:
      Architecture

      Description

      pycodestyle has accepted our patch to support W505 warnings for long docstrings. Flake8 now needs to be modified to allow the max docstring length to be included and propagated to pycodestyle. This is necessary because all of our checks rely on flake8 to call pycodestyle. The required steps are:

      • Beg pycodestyle to make a release with W505 enabled.
      • Make a pull request for flake8 adding the new functionality.
      • Update our pycodestyle EUPS package (or patch it locally).
      • Apply the patch locally to our flake8 package until a new flake8 release is made.

        Attachments

          Issue Links

            Activity

            Hide
            bvan Brian Van Klaveren added a comment -

            I did some work on this, although it's a bit tricky to test it out, because you really need a release of pycodestyle to adequately test it out.

            Show
            bvan Brian Van Klaveren added a comment - I did some work on this, although it's a bit tricky to test it out, because you really need a release of pycodestyle to adequately test it out.
            Hide
            tjenness Tim Jenness added a comment -

            Can you make a new eups release of pycodestyle with your patch applied?

            Show
            tjenness Tim Jenness added a comment - Can you make a new eups release of pycodestyle with your patch applied?
            Hide
            bvan Brian Van Klaveren added a comment -

            I can try that. I was able to get flake8 working with max-doc-length.

            Here is the commit that's working so far:

            https://github.com/brianv0/flake8/tree/ca127fdcc90fe941c25611eb25c0b64d8445c900/

            I'd need to do a commit to reformat the docstrings from 79 length to the 72 length across the flake8 repos (or just keep it at 79 for now)

            Show
            bvan Brian Van Klaveren added a comment - I can try that. I was able to get flake8 working with max-doc-length. Here is the commit that's working so far: https://github.com/brianv0/flake8/tree/ca127fdcc90fe941c25611eb25c0b64d8445c900/ I'd need to do a commit to reformat the docstrings from 79 length to the 72 length across the flake8 repos (or just keep it at 79 for now)
            Hide
            tjenness Tim Jenness added a comment -

            Brian Van Klaveren pycodestyle was released in January with the max-doc-length feature. This means we have no impediment to submitting a pull request to flake8 to enable the option.

            Show
            tjenness Tim Jenness added a comment - Brian Van Klaveren pycodestyle was released in January with the max-doc-length feature. This means we have no impediment to submitting a pull request to flake8 to enable the option.
            Hide
            bvan Brian Van Klaveren added a comment -

            This was already implemented by another developer in the flake8 package, and flake8 has be released with version 3.7.5.

            Show
            bvan Brian Van Klaveren added a comment - This was already implemented by another developer in the flake8 package, and flake8 has be released with version 3.7.5.
            Hide
            tjenness Tim Jenness added a comment -

            Marking as INVALID since the work was done elsewhere.

            Show
            tjenness Tim Jenness added a comment - Marking as INVALID since the work was done elsewhere.

              People

              Assignee:
              bvan Brian Van Klaveren
              Reporter:
              tjenness Tim Jenness
              Watchers:
              Brian Van Klaveren, Jonathan Sick, Kian-Tat Lim, Tim Jenness
              Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  Jenkins

                  No builds found.