Pylint fix 'missing-function-docstring', 'missing-class-docstring'. #37 Remove unnecessary pylint job 'Pylint Hard'. Remove pylint-exit from Pylint job.

Author: aleksandr-kotlyar

.gitlab/linter.yml

@@ -14,7 +14,7 @@ Pylint:
   allow_failure: true
   extends: .linter_template
   script:
-    - pylint --rcfile=pylintrc $PWD | tee ./pylint/pylint.log || pylint-exit $?; rm __init__.py
+    - pylint --rcfile=pylintrc $PWD | tee ./pylint/pylint.log
   after_script:
     - PYLINT_SCORE=$(sed -n 's/^Your code has been rated at \([-0-9.]*\)\/.*/\1/p' ./pylint/pylint.log)
     - echo $PYLINT_SCORE
@@ -26,11 +26,6 @@ Pylint:
     paths:
       - ./pylint/
 
-Pylint Hard:
-  extends: .linter_template
-  script:
-    - pylint --rcfile=pylintrc $PWD --disable=missing-function-docstring,missing-class-docstring
-
 #Quality Control:
 #  allow_failure: false
 #  stage: Merge Request

src/main/session.py

@@ -8,17 +8,17 @@
 
 
 class ApiSession(Session):
+    """Requests api session which Log request/response to allure attachments and console."""
 
     @allure_request_logger
     def request(self, method, url, **kwargs) -> Response:
-        """ Log request/response to allure and info"""
-
         response = super().request(method=method, url=url, **kwargs)
 
         return response
 
 
 class HttpbinApiSessionLevelOne(Session):
+    """Requests api session which has hardcoded base_url."""
 
     def request(self, method, url, **kwargs) -> Response:
         url = f'https://httpbin.org{url}'
@@ -27,6 +27,8 @@ def request(self, method, url, **kwargs) -> Response:
 
 
 class HttpbinApiSessionLevelTwo(Session):
+    """Requests api session which has hardcoded base_url.
+    And logs request/response into allure attachments."""
 
     def request(self, method, url, **kwargs) -> Response:
         url = f'https://httpbin.org{url}'

src/test/moretv/__init__.py

@@ -6,6 +6,7 @@
 
 
 def test_current_week_is_active(browser_module):
+    """Assert that /programm page opens tv-program schedule on current week."""
     logging.info('step1/2: start')
     browser_module.open('https://ctc.ru/programm')
     logging.info('step1/2: finish')
@@ -15,6 +16,7 @@ def test_current_week_is_active(browser_module):
 
 
 def test_current_week_has_words_in_days(browser_module):
+    """Assert that /program page current week slider has week as weekdays names."""
     logging.info('step1/2: start')
     browser_module.open('https://ctc.ru/programm')
     logging.info('step1/2: finish')
@@ -25,6 +27,7 @@ def test_current_week_has_words_in_days(browser_module):
 
 
 def test_today_is_active(browser_module):
+    """Assert that /programm page opens tv-schedule on today."""
     logging.info('step1/2: start')
     browser_module.open('https://ctc.ru/programm')
     logging.info('step1/2: finish')

src/test/moretv/main_page/__init__.py

@@ -1,3 +1,4 @@
+# pylint: disable=missing-function-docstring
 import json
 import os
 

src/test/old_ctc/__init__.py

@@ -1,4 +1,4 @@
-# pylint: disable=global-statement
+# pylint: disable=global-statement,missing-function-docstring
 import contextlib
 
 from pytest_voluptuous import S

src/test/old_ctc/tvprogram/__init__.py

@@ -21,10 +21,13 @@
 
 def test_list_of_dictionaries_does_not_duplicate_by_some_key_value():
     """
+
     1. create new dict with global keys by some key value which could repeat in list of dictionaries
     and append to this key a list of dictionaries, where this value figure
     2.  assert that dictionaries does not duplicate by some key's value
+
     """
+
     new_some_view = defaultdict(list)
 
     for some in SOMETHING:
@@ -42,6 +45,16 @@ def test_list_of_dictionaries_does_not_duplicate_by_some_key_value():
     Random().randints(20, 0, 10),
 ])
 def test_list_doesnt_have_duplicates(some_list):
+    """Parametrized test asserts there is no duplicate ints in list.
+
+    Using next features:
+    1. Random() function;
+    2. Sorting set;
+    3. Sorting list;
+    4. List comprehension;
+ 
+    """
+
     some_list.sort()
     logging.info(some_list)
 
@@ -53,20 +66,30 @@ def test_list_doesnt_have_duplicates(some_list):
 
 
 def has_duplicates(list_of_values):
+    """Returns True if there are duplicates in list.
+
+    Nothing special:
+    Simple cycle.
+    Uses any() method to check.
+
+    """
+
     value_dict = defaultdict(int)
     for item in list_of_values:
         value_dict[item] += 1
     return any(val > 1 for val in value_dict.values())
 
 
 def test_print_not_duplicated():
+    """Test for method has_duplicates returns False."""
     list_of_values = [2, -2]
 
     info(has_duplicates(list_of_values))
     assert has_duplicates(list_of_values) is False
 
 
 def test_print_duplicated():
+    """Test for method has_duplicates returns True."""
     list_of_values = [2, 2]
 
     info(has_duplicates(list_of_values))