search

carlmontanari / scrapli

Fast, flexible, sync/async, Python 3.7+ screen scraping client specifically for network devices
https://carlmontanari.github.io/scrapli/
MIT License
575 stars 59 forks source link

Replace darglint with pydoclint #312

Closed mattmess1221 closed 8 months ago

mattmess1221 commented 8 months ago

You should consider switching away from darglint. It's very slow, and pydoclint is 1000x faster. I tested it locally and it completed instantly, while darglint took several minutes.

carlmontanari commented 8 months ago

nod yeah been on my list to replace for a while, will give pydoclint a spin this weekend. I think if I recall darglint is last thing preventing gutting setup.cfg too so that would b great if pydoclint plays nice w/ pyproject.toml! thanks for the suggestion @killjoy1221 !

carlmontanari commented 8 months ago

did a very brief check and seems like it will defo not be an easy 1:1 swap cuz of some of the way docstrings are in scrapli sadly. quick example: every single func has raises/returns and just have N/A for things, pydoclint and docsig dislike this very much haha. probably they are "right" and I have a bad setup but... will be more effort than I care to deal w/ in the short term so going to back burner this again. realistically not a ton of commits happening and i don't mind wasting gh actions time to run darglint 😁