From f1ebc6eeba99e6475e1a1024e689cc4f3cd5ad42 Mon Sep 17 00:00:00 2001
From: Ilya Vlasov <ilyavlasov2011@gmail.com>
Date: Wed, 7 Jul 2021 11:40:20 +0300
Subject: [PATCH 1/2] Added whitelist

---
 src/python/review/inspectors/flake8/flake8.py |   2 +
 .../review/inspectors/flake8/whitelist.txt    | 127 ++++++++++++++++++
 2 files changed, 129 insertions(+)
 create mode 100644 src/python/review/inspectors/flake8/whitelist.txt

diff --git a/src/python/review/inspectors/flake8/flake8.py b/src/python/review/inspectors/flake8/flake8.py
index 5745a75f..244a2eed 100644
--- a/src/python/review/inspectors/flake8/flake8.py
+++ b/src/python/review/inspectors/flake8/flake8.py
@@ -21,6 +21,7 @@
 logger = logging.getLogger(__name__)
 
 PATH_FLAKE8_CONFIG = Path(__file__).parent / '.flake8'
+PATH_FLAKE8_SPELLCHECK_WHITELIST = Path(__file__).parent / 'whitelist.txt'
 FORMAT = '%(path)s:%(row)d:%(col)d:%(code)s:%(text)s'
 INSPECTOR_NAME = 'flake8'
 
@@ -34,6 +35,7 @@ def inspect(cls, path: Path, config: dict) -> List[BaseIssue]:
             'flake8',
             f'--format={FORMAT}',
             f'--config={PATH_FLAKE8_CONFIG}',
+            f'--whitelist={PATH_FLAKE8_SPELLCHECK_WHITELIST}',
             '--max-complexity', '0',
             '--cohesion-below', '100',
             path,
diff --git a/src/python/review/inspectors/flake8/whitelist.txt b/src/python/review/inspectors/flake8/whitelist.txt
new file mode 100644
index 00000000..47340d90
--- /dev/null
+++ b/src/python/review/inspectors/flake8/whitelist.txt
@@ -0,0 +1,127 @@
+aggfunc
+appendleft
+argmax
+asctime
+astype
+betavariate
+birthdate
+blackbox
+bs4
+byteorder
+calc
+capwords
+casefold
+caseless
+concat
+consts
+coord
+copysign
+csgraph
+ctime
+dataframe
+dataframes
+dataset
+datasets
+decrypted
+dedent
+deque
+desc
+devs
+df
+dicts
+dirs
+divmod
+dtype
+edu
+eig
+elems
+etree
+expm1
+falsy
+fillna
+floordiv
+fromstring
+fullmatch
+gensim
+gmtime
+groupby
+halfs
+hashable
+href
+hyp
+hyperskill
+iadd
+iloc
+inplace
+ints
+isalnum
+isalpha
+isin
+islice
+islower
+isnumeric
+isprintable
+istitle
+isub
+iterrows
+kcal
+kcals
+lastname
+lemmatize
+lemmatizer
+lifes
+lim
+linalg
+linspace
+lowercased
+lvl
+lxml
+matmul
+multiline
+ndarray
+ndigits
+ndim
+nltk
+nrows
+numpy
+nums
+ost
+param
+params
+parsers
+pathlib
+popleft
+pos
+punct
+readline
+rfind
+rindex
+rmdir
+schur
+scipy
+sigmoid
+sqrt
+src
+stemmer
+stepik
+subdicts
+subdir
+subdirs
+substr
+substring
+textwrap
+todos
+tokenize
+tokenized
+tokenizer
+tolist
+tracklist
+truediv
+truthy
+unpickled
+upd
+util
+utils
+webpage
+whitespaces
+writeback

From 562e1ed4820c7ead9c74e9cb1af1a6393c7da802 Mon Sep 17 00:00:00 2001
From: Ilya Vlasov <ilyavlasov2011@gmail.com>
Date: Sat, 10 Jul 2021 08:32:54 +0300
Subject: [PATCH 2/2] Added an explanation to the whitelist

---
 src/python/review/inspectors/flake8/flake8.py | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/src/python/review/inspectors/flake8/flake8.py b/src/python/review/inspectors/flake8/flake8.py
index 244a2eed..c5dfd274 100644
--- a/src/python/review/inspectors/flake8/flake8.py
+++ b/src/python/review/inspectors/flake8/flake8.py
@@ -21,6 +21,9 @@
 logger = logging.getLogger(__name__)
 
 PATH_FLAKE8_CONFIG = Path(__file__).parent / '.flake8'
+# To make the whitelist, a list of words was examined based on students' solutions
+# that were flagged by flake8-spellcheck as erroneous. In general, the whitelist included those words
+# that belonged to library methods and which were common abbreviations.
 PATH_FLAKE8_SPELLCHECK_WHITELIST = Path(__file__).parent / 'whitelist.txt'
 FORMAT = '%(path)s:%(row)d:%(col)d:%(code)s:%(text)s'
 INSPECTOR_NAME = 'flake8'