Comments (13)
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.
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.
Sorry, I don't understand you; could you clarify?
from pydocstyle.
@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.
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.
@sandreanybox As @halst pointed out, you can use our API as a workaround.
from pydocstyle.
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.
@sandreanybox Could you brief me, what does C95
refer to?
from pydocstyle.
@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.
@sigmavirus24 I see. Thanks for taking the time to explain this!
from pydocstyle.
@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.
@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.
Ok, I close it.
Thanks a lots everybody for take care of my problem...
from pydocstyle.
Related Issues (20)
- option to ban `noqa` comments that don't specify a code
- D102 - false positive on overload with comment
- cosmetic bug: wrong version stamp in webpage title: 1.0.0 instead of 2.1.1
- The match-dir parameter is not used. HOT 4
- Not detecting wrong DocStrings HOT 1
- Your website is down - https://pydocstyle.org HOT 3
- Crash with simple f-string HOT 7
- Docs website is down? HOT 1
- sdist: PKG-INFO should list LICENSE-MIT in License-File
- `D300` and `D301` false positives on docstrings with escaped triple quotes in them
- Should `__main__.py` really be considered a public module?
- Option to not report error for empty file HOT 1
- test_simple_fstring and test_fstring_with_args fail with Python 3.12 beta HOT 2
- 6.3.0: incorrect version in pyproject.toml?🤔 HOT 2
- pydocstyle 6.3.0 fails silently on a python script that has no .py extension
- Rule for missing PEP 698 `@overrides` decorators?
- Keyword Args not recognized in Google convention with no return
- Python3.12: Two tests fail HOT 1
- Google convention section names not properly checked
- D417 not raised in a standard Google configuration with missing arguments descriptions
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from pydocstyle.