Giter Site home page Giter Site logo

Entry point missing about pydocstyle HOT 13 CLOSED

pycqa avatar pycqa commented on June 25, 2024
Entry point missing

from pydocstyle.

Comments (13)

keleshev avatar keleshev commented on June 25, 2024

Right now pep257 has the following Python API: https://github.com/GreenSteam/pep257#python-api

Or what kind of entry point do you mean?

from pydocstyle.

sandreanybox avatar sandreanybox commented on June 25, 2024

Hum, i don't say if it's better. I would like like mccabe. For symbole référence, i think C95 is ok, but not sure. I ask here flake8 issue

from pydocstyle.

keleshev avatar keleshev commented on June 25, 2024

Sorry, I don't understand you; could you clarify?

from pydocstyle.

JensRantil avatar JensRantil commented on June 25, 2024

@halst wrote:

Sorry, I don't understand you; could you clarify?

After reading @sandreanybox's comments a couple of times and checking out the entry_points for mccabe, I just figured it out :-) @sandreanybox would like us to add similar entry points to pep257 since that's how flake8 picks up its plugins. It seems like this is in line with the effort discussed in the code-quality thread.

While there is an API, I have nothing against adding an entry_point in setup.py, too. @halst, do you? That said, it's not just for us to add an entry point. That entry point also need to support a common format that flake8 can understand. That's where the mailing list discussion comes in, I guess.

from pydocstyle.

sandreanybox avatar sandreanybox commented on June 25, 2024

Excuse me for my lack of clarity !
But i want to use your wonderful pep checker in flake8. For this purpose I need setuptools, particular log format, and a class for entry point. I have made my own branch here,And i will prevent you when my work will be functional.
thanks a lot
I you have work about this say to me.

from pydocstyle.

JensRantil avatar JensRantil commented on June 25, 2024

@sandreanybox As @halst pointed out, you can use our API as a workaround.

from pydocstyle.

sandreanybox avatar sandreanybox commented on June 25, 2024

work in progress,
https://github.com/sandreanybox/pep257/blob/master/pep257.py#L707
But I'm not sure to be in a good way !
work in progress...

from pydocstyle.

JensRantil avatar JensRantil commented on June 25, 2024

@sandreanybox Could you brief me, what does C95 refer to?

from pydocstyle.

sigmavirus24 avatar sigmavirus24 commented on June 25, 2024

@sandreanybox you're taking the wrong approach to this. Check out how PyFlakes works with Flake8. I'm somewhat certain that pep257 support can be added in a similar way to how flake8/_pyflakes.py works, just not by including it in the source of flake8. (Although I wouldn't be against default inclusion probably).

@JensRantil, C95 is the error code prefix for McCabe complexity errors, i.e., an error will be identified like so: C95x. We do the same for PyFlakes errors as well in the file I mentioned above.

I'm fairly certain we could wrap your API without significant (or ideally any) changes to pep257. I haven't had the chance to look into it myself though.

from pydocstyle.

JensRantil avatar JensRantil commented on June 25, 2024

@sigmavirus24 I see. Thanks for taking the time to explain this!

from pydocstyle.

sandreanybox avatar sandreanybox commented on June 25, 2024

@sigmavirus24
Hey,
I took more time for inspect all related flake8 module.
pep8 use ast class checker, and logical line / physical line function checker
pyflakes have an AST class checker
Mccabe also

I have made an class like ast checker, and I parse all file with check_source.
I can't do better without refactoring.
For flake8 extension code i use for test purpose G20
And I've add some code error to all check function.
I can add options.select error code. But i need check before proceeding.
maybe I'm totally in the wrong way :(
My branch is here

Thanks

from pydocstyle.

sigmavirus24 avatar sigmavirus24 commented on June 25, 2024

@sandreanybox you're definitely doing far more work than is necessary and most likely on the completely wrong track. Let's close this issue and communicate elsewhere. This isn't a bug or such with pep257. Thanks

from pydocstyle.

sandreanybox avatar sandreanybox commented on June 25, 2024

Ok, I close it.
Thanks a lots everybody for take care of my problem...

from pydocstyle.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.