FM / pydocstyle

/opt/cloudlinux/venv/lib/python3.11/site-packages/pydocstyle/

/opt/cloudlinux/venv/lib/python3.11/site-packages/pydocstyle

Name	Size	Mode	Actions
data/	-	0755	rm
__pycache__/	-	0755	rm
checker.py	44884	0644	edit dl rm
cli.py	2993	0644	edit dl rm
config.py	33488	0644	edit dl rm
parser.py	28291	0644	edit dl rm
utils.py	1291	0644	edit dl rm
violations.py	12411	0644	edit dl rm
wordlists.py	1548	0644	edit dl rm
_version.py	400	0644	edit dl rm
__init__.py	194	0644	edit dl rm
__main__.py	288	0644	edit dl rm

Edit: /opt/cloudlinux/venv/lib/python3.11/site-packages/pydocstyle/wordlists.py (1548B)

"""Wordlists loaded from package data.

We can treat them as part of the code for the imperative mood check, and
therefore we load them at import time, rather than on-demand.

"""
import pkgutil
import re
from typing import Dict, Iterator, Set

import snowballstemmer

#: Regular expression for stripping comments from the wordlists
COMMENT_RE = re.compile(r'\s*#.*')

#: Stemmer function for stemming words in English
stem = snowballstemmer.stemmer('english').stemWord

def load_wordlist(name: str) -> Iterator[str]:
    """Iterate over lines of a wordlist data file.

`name` should be the name of a package data file within the data/
    directory.

Whitespace and #-prefixed comments are stripped from each line.

"""
    data = pkgutil.get_data('pydocstyle', 'data/' + name)
    if data is not None:
        text = data.decode('utf8')
        for line in text.splitlines():
            line = COMMENT_RE.sub('', line).strip()
            if line:
                yield line

def make_imperative_verbs_dict(wordlist: Iterator[str]) -> Dict[str, Set[str]]:
    """Create a dictionary mapping stemmed verbs to the imperative form."""
    imperative_verbs = {}  # type: Dict[str, Set[str]]
    for word in wordlist:
        imperative_verbs.setdefault(stem(word), set()).add(word)
    return imperative_verbs

IMPERATIVE_VERBS = make_imperative_verbs_dict(load_wordlist('imperatives.txt'))

#: Words that are forbidden to appear as the first word in a docstring
IMPERATIVE_BLACKLIST = set(load_wordlist('imperatives_blacklist.txt'))

"""Wordlists loaded from package data. We can treat them as part of the code for the imperative mood check, and therefore we load them at import time, rather than on-demand. """ import pkgutil import re from typing import Dict, Iterator, Set import snowballstemmer #: Regular expression for stripping comments from the wordlists COMMENT_RE = re.compile(r'\s*#.*') #: Stemmer function for stemming words in English stem = snowballstemmer.stemmer('english').stemWord def load_wordlist(name: str) -> Iterator[str]: """Iterate over lines of a wordlist data file. `name` should be the name of a package data file within the data/ directory. Whitespace and #-prefixed comments are stripped from each line. """ data = pkgutil.get_data('pydocstyle', 'data/' + name) if data is not None: text = data.decode('utf8') for line in text.splitlines(): line = COMMENT_RE.sub('', line).strip() if line: yield line def make_imperative_verbs_dict(wordlist: Iterator[str]) -> Dict[str, Set[str]]: """Create a dictionary mapping stemmed verbs to the imperative form.""" imperative_verbs = {} # type: Dict[str, Set[str]] for word in wordlist: imperative_verbs.setdefault(stem(word), set()).add(word) return imperative_verbs IMPERATIVE_VERBS = make_imperative_verbs_dict(load_wordlist('imperatives.txt')) #: Words that are forbidden to appear as the first word in a docstring IMPERATIVE_BLACKLIST = set(load_wordlist('imperatives_blacklist.txt'))