Merge pull request #317 from zowe/function_case

Function case

.github/workflows/sdk-build.yml

@@ -32,12 +32,12 @@ jobs:
         run: pydocstyle --match-dir='^(?!build$).*' --match='^(?!(__init__\.py|setup\.py$)).*\.py$' src
       - name: Lint with pydoclint
         run: pydoclint --exclude='.*/build/.*' src
-      - name: Lint with flake8
-        run: |
-          # stop the build if there are Python syntax errors or undefined names
-          flake8 ./src --count --select=E9,F63,F7,F82 --show-source --statistics
-          # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
-          flake8 ./src --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+      - name: Lint with pylint
+        run: | 
+          # check for Python errors
+          pylint src --errors-only --disable=E0401,E0611 --ignore=build
+          # check for lint
+          pylint ./src --disable=all --enable=C0103,C0301 --ignore=build --max-line-length=127
       - name: Test with pytest
         run: |
           coverage run -m pytest ./tests/unit

.vscode/settings.json

@@ -19,4 +19,6 @@
         "./src/zos_jobs",
         "./src/zosmf"
     ],
+    "python.linting.enabled": true,
+    "python.linting.pylintEnabled": true,
 }

CHANGELOG.md

@@ -10,6 +10,8 @@ All notable changes to the Zowe Client Python SDK will be documented in this fil
 
 - Add type annotations for all methods [#280] (https://github.com/zowe/zowe-client-python-sdk/issues/280)
 
+- *Breaking*: Revised function names in `Logger` class and `files` class into snake_case. Enabled pylint rule to enforce function case. [#315] (https://github.com/zowe/zowe-client-python-sdk/issues/315)
+
 ### Bug Fixes
 
 ## `1.0.0-dev18`

CONTRIBUTING.md

@@ -65,6 +65,6 @@ Code standards
 
 This project follows the [PEP 8](https://www.python.org/dev/peps/pep-0008/) style guide.
 
-This project also uses `flake8` for code linting. Make sure to run `flake8` on your code before submitting a pull request.
+This project also uses `pydocstyle`, `pydoclint`, and `pylint` for code linting. Make sure to run them on your code before submitting a pull request.
 
 We recommend using `black` and `isort` as code formatters. Please format your code using these tools before creating a pull request.

requirements.txt

@@ -1,11 +1,10 @@
 black
 certifi==2024.7.4
 chardet==4.0.0
-colorama==0.4.4
+colorama==0.4.5
 commentjson==0.9.0
 coverage==5.4
 deepmerge==1.1.0
-flake8==5.0.0
 idna==3.7
 importlib-metadata==3.6.0;python_version<"3.8"
 isort
@@ -18,8 +17,8 @@ pycodestyle==2.9.0
 pydocstyle==5.1.1
 pydoclint==0.5.3
 pyfakefs
-pyflakes==2.5.0
 pylama==7.7.1
+pylint==3.2.5
 pytest==7.1.2
 python-decouple==3.4
 PyYAML==6.0.1

src/core/zowe/core_for_zowe_sdk/config_file.py

@@ -75,7 +75,7 @@ class ConfigFile:
     jsonc: Optional[dict] = None
     _missing_secure_props: list = field(default_factory=list)
 
-    __logger = Log.registerLogger(__name__)
+    __logger = Log.register_logger(__name__)
 
     @property
     def filename(self) -> str:

src/core/zowe/core_for_zowe_sdk/connection.py

@@ -36,7 +36,7 @@ class ApiConnection:
     """
 
     def __init__(self, host_url: str, user: str, password: str, ssl_verification: bool = True):
-        __logger = Log.registerLogger(__name__)
+        __logger = Log.register_logger(__name__)
         if not host_url or not user or not password:
             __logger.error("Missing connection argument")
             raise MissingConnectionArgs()

src/core/zowe/core_for_zowe_sdk/credential_manager.py

@@ -31,7 +31,7 @@ class CredentialManager:
     """A class including static functions for managing credentials."""
 
     secure_props = {}
-    __logger = Log.registerLogger(__name__)
+    __logger = Log.register_logger(__name__)
 
     @staticmethod
     def load_secure_props() -> None:

src/core/zowe/core_for_zowe_sdk/logger.py

@@ -44,7 +44,7 @@ class Log:
     loggers: set = set()
 
     @staticmethod
-    def registerLogger(name: str) -> logging.Logger:
+    def register_logger(name: str) -> logging.Logger:
         """
         Create and register a logger.
 
@@ -68,7 +68,7 @@ def registerLogger(name: str) -> logging.Logger:
         return logger
 
     @staticmethod
-    def setAllLoggerLevel(level: int):
+    def set_all_logger_level(level: int):
         """
         Set display level for all loggers.
 
@@ -107,13 +107,13 @@ def open(logger: logging.Logger):
         logger.disabled = False
 
     @staticmethod
-    def closeAll():
+    def close_all():
         """Disable all loggers."""
         for logger in Log.loggers:
             logger.disabled = True
 
     @staticmethod
-    def openAll():
+    def open_all():
         """Enable all loggers."""
         for logger in Log.loggers:
             logger.disabled = False

src/core/zowe/core_for_zowe_sdk/profile_manager.py

@@ -16,8 +16,14 @@
 from copy import deepcopy
 from typing import Optional
 
-import jsonschema
 from deepmerge import always_merger
+from jsonschema.exceptions import (
+    FormatError,
+    SchemaError,
+    UndefinedTypeCheck,
+    UnknownType,
+    ValidationError,
+)
 
 from .config_file import ConfigFile, Profile
 from .credential_manager import CredentialManager
@@ -67,7 +73,7 @@ def __init__(self, appname: Optional[str] = "zowe", show_warnings: Optional[bool
         self.__project_config = ConfigFile(type=TEAM_CONFIG, name=appname)
         self.__project_user_config = ConfigFile(type=USER_CONFIG, name=appname)
 
-        self.__logger = Log.registerLogger(__name__)
+        self.__logger = Log.register_logger(__name__)
 
         self.__global_config = ConfigFile(type=TEAM_CONFIG, name=GLOBAL_CONFIG_NAME)
         try:
@@ -261,32 +267,32 @@ def get_profile(
         FormatError
             If validating a format in the configuration fails.
         """
-        logger = Log.registerLogger(__name__)
+        logger = Log.register_logger(__name__)
 
         cfg_profile = Profile()
         try:
             cfg_profile = cfg.get_profile(
                 profile_name=profile_name, profile_type=profile_type, validate_schema=validate_schema
             )
-        except jsonschema.exceptions.ValidationError as exc:
+        except ValidationError as exc:
             logger.error(f"Instance was invalid under the provided $schema property, {exc}")
-            raise jsonschema.exceptions.ValidationError(
-                f"Instance was invalid under the provided $schema property, {exc}"
-            )
-        except jsonschema.exceptions.SchemaError as exc:
+            raise ValidationError(f"Instance was invalid under the provided $schema property, {exc}")
+        except SchemaError as exc:
             logger.error(f"The provided schema is invalid, {exc}")
-            raise jsonschema.exceptions.SchemaError(f"The provided schema is invalid, {exc}")
-        except jsonschema.exceptions.UndefinedTypeCheck as exc:
+            raise SchemaError(f"The provided schema is invalid, {exc}")
+        except UndefinedTypeCheck as exc:
             logger.error(f"A type checker was asked to check a type it did not have registered, {exc}")
-            raise jsonschema.exceptions.UndefinedTypeCheck(
-                f"A type checker was asked to check a type it did not have registered, {exc}"
-            )
-        except jsonschema.exceptions.UnknownType as exc:
+            raise UndefinedTypeCheck(f"A type checker was asked to check a type it did not have registered, {exc}")
+        except UnknownType as exc:
             logger.error(f"Unknown type is found in schema_json, {exc}")
-            raise jsonschema.exceptions.UnknownType(f"Unknown type is found in schema_json, {exc}")
-        except jsonschema.exceptions.FormatError as exc:
+            raise UnknownType(
+                f"Unknown type is found in schema_json, {exc}",
+                instance=profile_name,
+                schema=validate_schema,
+            )
+        except FormatError as exc:
             logger.error(f"Validating a format config_json failed for schema_json, {exc}")
-            raise jsonschema.exceptions.FormatError(f"Validating a format config_json failed for schema_json, {exc}")
+            raise FormatError(f"Validating a format config_json failed for schema_json, {exc}")
         except ProfileNotFound:
             if profile_name:
                 logger.warning(f"Profile '{profile_name}' not found in file '{cfg.filename}'")
@@ -405,13 +411,13 @@ def load(
                 cfg_schema = cfg_layer.schema_property
                 cfg_schema_dir = cfg_layer._location
 
-        usrProject = self.__project_user_config.profiles or {}
+        usr_project = self.__project_user_config.profiles or {}
         project = self.__project_config.profiles or {}
-        project_temp = always_merger.merge(deepcopy(project), usrProject)
+        project_temp = always_merger.merge(deepcopy(project), usr_project)
 
-        usrGlobal = self.__global_user_config.profiles or {}
+        usr_global = self.__global_user_config.profiles or {}
         global_ = self.__global_config.profiles or {}
-        global_temp = always_merger.merge(deepcopy(global_), usrGlobal)
+        global_temp = always_merger.merge(deepcopy(global_), usr_global)
 
         profiles_merged = project_temp
         for name, value in global_temp.items():

src/core/zowe/core_for_zowe_sdk/request_handler.py

@@ -36,7 +36,7 @@ def __init__(self, session_arguments: dict, logger_name: str = __name__):
         self.session_arguments = session_arguments
         self.__valid_methods = ["GET", "POST", "PUT", "DELETE"]
         self.__handle_ssl_warnings()
-        self.__logger = Log.registerLogger(logger_name)
+        self.__logger = Log.register_logger(logger_name)
 
     def __handle_ssl_warnings(self):
         """Turn off warnings if the SSL verification argument if off."""
@@ -121,7 +121,9 @@ def __validate_response(self):
         if self.__response.ok:
             if self.__response.status_code not in self.__expected_code:
                 self.__logger.error(
-                    f"The status code from z/OSMF was: {self.__expected_code}\nExpected: {self.__response.status_code}\nRequest output:{self.__response.text}"
+                    f"The status code from z/OSMF was: {self.__expected_code}\n"
+                    f"Expected: {self.__response.status_code}\n"
+                    f"Request output: {self.__response.text}"
                 )
                 raise UnexpectedStatus(self.__expected_code, self.__response.status_code, self.__response.text)
         else:
@@ -146,10 +148,10 @@ def __normalize_response(self) -> Union[str, bytes, dict]:
             - `str` when the response is plain text
             - `dict` when the response is json
         """
-        contentType = self.__response.headers.get("Content-Type")
-        if contentType == "application/octet-stream":
+        content_type = self.__response.headers.get("Content-Type")
+        if content_type == "application/octet-stream":
             return self.__response.content
-        elif contentType and contentType.startswith("application/json"):
+        elif content_type and content_type.startswith("application/json"):
             return "" if self.__response.text == "" else self.__response.json()
         else:
             return self.__response.text

src/core/zowe/core_for_zowe_sdk/sdk_api.py

@@ -37,7 +37,7 @@ def __init__(self, profile: dict, default_url: str, logger_name: str = __name__)
         session = Session(profile)
         self.session: ISession = session.load()
 
-        self.logger = Log.registerLogger(logger_name)
+        self.logger = Log.register_logger(logger_name)
 
         self._default_service_url = default_url
         self._default_headers = {
@@ -52,17 +52,17 @@ def __init__(self, profile: dict, default_url: str, logger_name: str = __name__)
             "headers": self._default_headers,
         }
         self.__session_arguments = {
-            "verify": self.session.rejectUnauthorized,
+            "verify": self.session.reject_unauthorized,
             "timeout": 30,
         }
         self.request_handler = RequestHandler(self.__session_arguments, logger_name=logger_name)
 
         if self.session.type == session_constants.AUTH_TYPE_BASIC:
             self._request_arguments["auth"] = (self.session.user, self.session.password)
         elif self.session.type == session_constants.AUTH_TYPE_BEARER:
-            self._default_headers["Authorization"] = f"Bearer {self.session.tokenValue}"
+            self._default_headers["Authorization"] = f"Bearer {self.session.token_value}"
         elif self.session.type == session_constants.AUTH_TYPE_TOKEN:
-            self._default_headers["Cookie"] = f"{self.session.tokenType}={self.session.tokenValue}"
+            self._default_headers["Cookie"] = f"{self.session.token_type}={self.session.token_value}"
         elif self.session.type == session_constants.AUTH_TYPE_CERT_PEM:
             self.__session_arguments["cert"] = self.session.cert
 

src/core/zowe/core_for_zowe_sdk/session.py

@@ -23,14 +23,14 @@ class ISession:
 
     host: str
     port: int = session_constants.DEFAULT_HTTPS_PORT
-    rejectUnauthorized: bool = True
+    reject_unauthorized: bool = True
     user: Optional[str] = None
     password: Optional[str] = None
     protocol: str = session_constants.HTTPS_PROTOCOL
-    basePath: Optional[str] = None
+    base_path: Optional[str] = None
     type: Optional[str] = None
-    tokenType: Optional[str] = None
-    tokenValue: Optional[str] = None
+    token_type: Optional[str] = None
+    token_value: Optional[str] = None
     cert: Optional[str] = None
 
 
@@ -51,7 +51,7 @@ class Session:
 
     def __init__(self, props: dict) -> None:
         # set host and port
-        self.__logger = Log.registerLogger(__name__)
+        self.__logger = Log.register_logger(__name__)
 
         if props.get("host") is not None:
             self.session: ISession = ISession(host=props.get("host"))
@@ -63,33 +63,33 @@ def __init__(self, props: dict) -> None:
         if props.get("user") is not None and props.get("password") is not None:
             self.session.user = props.get("user")
             self.session.password = props.get("password")
-            self.session.rejectUnauthorized = props.get("rejectUnauthorized")
+            self.session.reject_unauthorized = props.get("rejectUnauthorized")
             self.session.type = session_constants.AUTH_TYPE_BASIC
         elif props.get("tokenType") is not None and props.get("tokenValue") is not None:
-            self.session.tokenType = props.get("tokenType")
-            self.session.tokenValue = props.get("tokenValue")
+            self.session.token_type = props.get("tokenType")
+            self.session.token_value = props.get("tokenValue")
             self.session.type = session_constants.AUTH_TYPE_TOKEN
         elif props.get("tokenValue") is not None:
-            self.session.tokenValue = props.get("tokenValue")
+            self.session.token_value = props.get("tokenValue")
             self.session.type = session_constants.AUTH_TYPE_BEARER
         elif props.get("certFile") is not None:
             if props.get("certKeyFile"):
                 self.session.cert = (props.get("certFile"), props.get("certKeyFile"))
             else:
                 self.__logger.error("A certificate key file must be provided when certFile is specified")
                 raise Exception("A certificate key file must be provided when certFile is specified")
-            self.session.rejectUnauthorized = props.get("rejectUnauthorized")
+            self.session.reject_unauthorized = props.get("rejectUnauthorized")
             self.session.type = session_constants.AUTH_TYPE_CERT_PEM
         else:
             self.session.type = session_constants.AUTH_TYPE_NONE
             self.__logger.info("Authentication method not supplied")
             # raise Exception("An authentication method must be supplied")
 
         # set additional parameters
-        self.session.basePath = props.get("basePath")
+        self.session.base_path = props.get("basePath")
         self.session.port = props.get("port", self.session.port)
         self.session.protocol = props.get("protocol", self.session.protocol)
-        self.session.rejectUnauthorized = False if props.get("rejectUnauthorized") == False else True
+        self.session.reject_unauthorized = False if props.get("rejectUnauthorized") == False else True
 
     def load(self) -> ISession:
         """
@@ -112,5 +112,5 @@ def host_url(self) -> str:
         str
             the formatted host URL
         """
-        basePath = self.session.basePath or ""
-        return f"{self.session.protocol}://{self.session.host}:{self.session.port}{basePath}"
+        base_path = self.session.base_path or ""
+        return f"{self.session.protocol}://{self.session.host}:{self.session.port}{base_path}"

src/core/zowe/core_for_zowe_sdk/zosmf_profile.py

@@ -46,7 +46,7 @@ class ZosmfProfile:
 
     def __init__(self, profile_name: str):
         self.__profile_name = profile_name
-        self.__logger = Log.registerLogger(__name__)
+        self.__logger = Log.register_logger(__name__)
 
     @property
     def profiles_dir(self) -> str:

src/zos_files/zowe/zos_files_for_zowe_sdk/datasets.py

@@ -21,7 +21,6 @@
 _ZOWE_FILES_DEFAULT_ENCODING = zos_file_constants["ZoweFilesDefaultEncoding"]
 
 
-@dataclass
 class DatasetOption:
     """A dataclass that represents options for creating a dataset.
 

src/zos_files/zowe/zos_files_for_zowe_sdk/files.py

@@ -158,11 +158,11 @@ def delete_data_set(self, dataset_name, volume=None, member_name=None):
         """Use ds.delete() instead of this deprecated function."""
         return self.ds.delete(dataset_name, volume, member_name)
 
-    def create_zFS_file_system(self, file_system_name, options={}):
+    def create_zfs_file_system(self, file_system_name, options={}):
         """Use fs.create() instead of this deprecated function."""
         return self.fs.create(file_system_name, options)
 
-    def delete_zFS_file_system(self, file_system_name):
+    def delete_zfs_file_system(self, file_system_name):
         """Use fs.delete() instead of this deprecated function."""
         return self.fs.delete(file_system_name)