?HAMA

Navigation

Breadcrumbs

Create

Edit File Size: 1.51 KB

/proc/self/root/proc/thread-self/root/opt/cloudlinux/venv/lib/python3.11/site-packages/pydocstyle/wordlists.py

Text Base64

"""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'))

Exit & Reset Text mode: syntax highlighting auto-detects file type.

Name	Size	Perms	Modified	Actions
data DIR	-	drwxr-xr-x	2026-02-06 08:01:08	Edit Download recursive recursive
__pycache__ DIR	-	drwxr-xr-x	2026-02-06 08:01:08	Edit Download recursive recursive
checker.py	43.83 KB	lrw-r--r--	2026-01-20 13:01:47	Edit Download recursive recursive
cli.py	2.92 KB	lrw-r--r--	2026-01-20 13:01:47	Edit Download recursive recursive
config.py	32.70 KB	lrw-r--r--	2026-01-20 13:01:47	Edit Download recursive recursive
parser.py	27.63 KB	lrw-r--r--	2026-01-20 13:01:47	Edit Download recursive recursive
utils.py	1.26 KB	lrw-r--r--	2026-01-20 13:01:47	Edit Download recursive recursive
violations.py	12.12 KB	lrw-r--r--	2026-01-20 13:01:47	Edit Download recursive recursive
wordlists.py	1.51 KB	lrw-r--r--	2026-01-20 13:01:47	Edit Download recursive recursive
_version.py	400 B	lrw-r--r--	2026-01-20 13:01:47	Edit Download recursive recursive
__init__.py	194 B	lrw-r--r--	2026-01-20 13:01:47	Edit Download recursive recursive
__main__.py	288 B	lrw-r--r--	2026-01-20 13:01:47	Edit Download recursive recursive

Directory Contents