Squash pylint errors

Author: gustavocidornelas

openlayer/__init__.py

@@ -11,7 +11,7 @@
 
 from . import api, exceptions, utils, validators
 from .projects import Project
-from .schemas import DatasetSchema, ModelSchema, ShellModelSchema
+from .schemas import BaselineModelSchema, DatasetSchema, ModelSchema, ShellModelSchema
 from .tasks import TaskType
 from .version import __version__  # noqa: F401
 
@@ -216,7 +216,6 @@ def create_or_load_project(
     def add_model(
         self,
         model_config_file_path: str,
-        task_type: TaskType,
         model_package_dir: Optional[str] = None,
         sample_data: Optional[pd.DataFrame] = None,
         force: bool = False,
@@ -452,7 +451,7 @@ def add_baseline_model(
         """
         **Coming soon...**
 
-        Add a baseline model to the project.
+        Adds a baseline model to the project.
 
         Baseline models should be added together with training and validation
         sets. A model will then be trained on the platform using AutoML, using
@@ -508,7 +507,7 @@ def add_baseline_model(
         model_config = {}
         if model_config_file_path is not None:
             model_config = utils.read_yaml(model_config_file_path)
-        model_data = schemas.BaselineModelSchema().load(model_config)
+        model_data = BaselineModelSchema().load(model_config)
 
         # Copy relevant resources to temp directory
         with tempfile.TemporaryDirectory() as temp_dir:
@@ -525,7 +524,6 @@ def add_dataset(
         self,
         file_path: str,
         dataset_config_file_path: str,
-        task_type: TaskType,
         project_id: str = None,
         force: bool = False,
     ):
@@ -584,8 +582,9 @@ class probabilities. For example, for a binary classification
                     Delimiter to use. E.g. `'\\t'`.
         force : bool
             If :obj:`add_dataset` is called when there is already a dataset of the same type
-            in the staging area, when ``force=True``, the existing staged dataset will be overwritten
-            by the new one. When ``force=False``, the user will be prompted to confirm the overwrite.
+            in the staging area, when ``force=True``, the existing staged dataset will be
+            overwritten by the new one. When ``force=False``, the user will be prompted
+            to confirm the overwrite.
 
         Notes
         -----
@@ -734,17 +733,16 @@ class probabilities. For example, for a binary classification
 
     def add_dataframe(
         self,
-        df: pd.DataFrame,
+        dataset_df: pd.DataFrame,
         dataset_config_file_path: str,
-        task_type: TaskType,
         project_id: str = None,
         force: bool = False,
     ):
         r"""Adds a dataset to a project's staging area (from a pandas DataFrame).
 
         Parameters
         ----------
-        df : pd.DataFrame
+        dataset_df : pd.DataFrame
             Dataframe containing your dataset.
         dataset_config_file_path : str
             Path to the dataset configuration YAML file.
@@ -794,9 +792,10 @@ class probabilities. For example, for a binary classification
                 - ``sep`` : str, default ','
                     Delimiter to use. E.g. `'\\t'`.
         force : bool
-            If :obj:`add_dataframe` is called when there is already a dataset of the same type in the
-            staging area, when ``force=True``, the existing staged dataset will be overwritten
-            by the new one. When ``force=False``, the user will be prompted to confirm the overwrite.
+            If :obj:`add_dataframe` is called when there is already a dataset of the same
+            type in the staging area, when ``force=True``, the existing staged dataset will
+            be overwritten by the new one. When ``force=False``, the user will be prompted
+            to confirm the overwrite.
 
         Notes
         -----
@@ -858,7 +857,7 @@ class probabilities. For example, for a binary classification
         You can now add this dataset to your project with:
 
         >>> project.add_dataframe(
-        ...     df=df,
+        ...     dataset_df=df,
         ...     dataset_config_file_path='/path/to/dataset_config.yaml',
         ... )
 
@@ -899,7 +898,7 @@ class probabilities. For example, for a binary classification
         You can now add this dataset to your project with:
 
         >>> project.add_dataframe(
-        ...     df=df,
+        ...     dataset_df=df,
         ...     dataset_config_file_path='/path/to/dataset_config.yaml',
         ... )
 
@@ -913,16 +912,16 @@ class probabilities. For example, for a binary classification
         >>> project.push()
         """
         # --------------------------- Resource validations --------------------------- #
-        if not isinstance(df, pd.DataFrame):
+        if not isinstance(dataset_df, pd.DataFrame):
             raise exceptions.OpenlayerValidationError(
-                f"- `df` is a `{type(df)}`, but it must be of type `pd.DataFrame`. \n"
+                f"- `dataset_df` is a `{type(dataset_df)}`, but it must be of type"
+                " `pd.DataFrame`. \n"
             ) from None
         with tempfile.TemporaryDirectory() as tmp_dir:
             file_path = os.path.join(tmp_dir, str(uuid.uuid1()))
-            df.to_csv(file_path, index=False)
+            dataset_df.to_csv(file_path, index=False)
             return self.add_dataset(
                 file_path=file_path,
-                task_type=task_type,
                 project_id=project_id,
                 dataset_config_file_path=dataset_config_file_path,
                 force=force,
@@ -946,21 +945,21 @@ def commit(self, message: str, project_id: int, force: bool = False):
 
         Examples
         --------
-        A commit message is associated with a project version. We have a new project version every time
-        any of its resources (namely, model and/or dataset) are updated. The commit message is supposed
-        to be a short description of the changes from one version to the next.
+        A commit message is associated with a project version. We have a new project version
+        every time any of its resources (namely, model and/or dataset) are updated. The commit
+        message is supposed to be a short description of the changes from one version to the next.
 
-        Let's say you have a project with a model and a dataset staged. You can confirm these resources
-        are indeed in the staging area using the :obj:`status` method:
+        Let's say you have a project with a model and a dataset staged. You can confirm these
+        resources are indeed in the staging area using the :obj:`status` method:
 
         >>> project.status()
 
         Now, you can add a commit message to the staged resources.
 
         >>> project.commit("Initial commit.")
 
-        After adding the commit message, the resources are ready to be pushed to the platform. You use
-        the :obj:`push` method to do so:
+        After adding the commit message, the resources are ready to be pushed to the platform.
+        You use the :obj:`push` method to do so:
 
         >>> project.push()
         """
@@ -988,7 +987,9 @@ def commit(self, message: str, project_id: int, force: bool = False):
             overwrite = "n"
 
             if not force:
-                with open(f"{project_dir}/commit.yaml", "r") as commit_file:
+                with open(
+                    f"{project_dir}/commit.yaml", "r", encoding="UTF-8"
+                ) as commit_file:
                     commit = yaml.safe_load(commit_file)
                     print(
                         f"\t - Commit message: `{commit['message']}` \n \t - Date: {commit['date']}"
@@ -1005,7 +1006,7 @@ def commit(self, message: str, project_id: int, force: bool = False):
                 return
 
         commit = dict(message=message, date=time.ctime())
-        with open(f"{project_dir}/commit.yaml", "w") as commit_file:
+        with open(f"{project_dir}/commit.yaml", "w", encoding="UTF-8") as commit_file:
             yaml.dump(commit, commit_file)
 
         print("Committed!")
@@ -1048,7 +1049,7 @@ def push(self, project_id: int):
             )
             return
 
-        with open(f"{project_dir}/commit.yaml", "r") as commit_file:
+        with open(f"{project_dir}/commit.yaml", "r", encoding="UTF-8") as commit_file:
             commit = yaml.safe_load(commit_file)
 
         # Validate bundle resources
@@ -1130,7 +1131,7 @@ def status(self, project_id: int):
             print("Use the `commit` method to add a commit message to your changes.")
             return
 
-        with open(f"{project_dir}/commit.yaml", "r") as commit_file:
+        with open(f"{project_dir}/commit.yaml", "r", encoding="UTF-8") as commit_file:
             commit = yaml.safe_load(commit_file)
         print("The following resources are committed, waiting to be pushed:")
         for file in os.listdir(project_dir):
@@ -1209,8 +1210,8 @@ def _stage_resource(
         """
         if resource_name not in VALID_RESOURCE_NAMES:
             raise ValueError(
-                f"Resource name must be one of 'baseline-model', 'model', 'training', or 'validation',"
-                f" but got '{resource_name}'."
+                "Resource name must be one of 'baseline-model', 'model', 'training', or"
+                f" 'validation', but got '{resource_name}'."
             )
 
         project_dir = f"{OPENLAYER_DIR}/{project_id}/staging"
@@ -1220,15 +1221,17 @@ def _stage_resource(
         if resource_name == "model" and "baseline-model" in resources_staged:
             raise exceptions.OpenlayerException(
                 "Trying to stage a `model` when there is a `baseline-model` already staged."
-                + " You can either add a `model` or a `baseline-model`, but not both at the same time."
-                + " Please remove one of them from the staging area using the `restore` method."
+                + " You can either add a `model` or a `baseline-model`, but not both at the"
+                + " same time. Please remove one of them from the staging area using the"
+                + " `restore` method."
             ) from None
 
         if resource_name == "baseline-model" and "model" in resources_staged:
             raise exceptions.OpenlayerException(
                 "Trying to stage a `baseline-model` when there is a `model` already staged."
-                + " You can either add a `model` or a `baseline-model`, but not both at the same time."
-                + " Please remove one of them from the staging area using the `restore` method."
+                + " You can either add a `model` or a `baseline-model`, but not both at the"
+                + " same time. Please remove one of them from the staging area using the"
+                + " `restore` method."
             ) from None
 
         if resource_name in resources_staged:

openlayer/exceptions.py

@@ -1,3 +1,10 @@
+"""A collection of the different Openlayer Python client exceptions and their error codes.
+
+Typical usage example:
+
+  if project is None:
+    raise errors.OpenlayerResourceNotFound(f"Project {project_id} does not exist")
+"""
 from typing import Dict
 
 
@@ -21,11 +28,15 @@ def __init__(self, message, errcode=None):
 
 
 class OpenlayerValidationError(OpenlayerException):
+    """Failed resource validations"""
+
     def __init__(self, message):
         super().__init__(message)
 
 
 class OpenlayerSubscriptionPlanException(OpenlayerException):
+    """Subscription plan exception class"""
+
     def __init__(self, message, context=None, mitigation=None):
         context = context or "You have reached your subscription plan's limits. \n"
         mitigation = mitigation or "To upgrade your plan, visit https://openlayer.com"

openlayer/projects.py

@@ -1,3 +1,7 @@
+"""
+Module for the Project class.
+"""
+
 from . import tasks
 
 
@@ -39,15 +43,15 @@ def add_model(
         *args,
         **kwargs,
     ):
-        return self.client.add_model(
-            *args, project_id=self.id, task_type=tasks.TaskType(self.taskType), **kwargs
-        )
+        """Adds a model to a project's staging area."""
+        return self.client.add_model(*args, project_id=self.id, **kwargs)
 
     def add_baseline_model(
         self,
         *args,
         **kwargs,
     ):
+        """Adds a baseline model to the project."""
         return self.client.add_baseline(
             *args, project_id=self.id, task_type=tasks.TaskType(self.taskType), **kwargs
         )
@@ -57,23 +61,25 @@ def add_dataset(
         *args,
         **kwargs,
     ):
-        return self.client.add_dataset(
-            *args, project_id=self.id, task_type=tasks.TaskType(self.taskType), **kwargs
-        )
+        """Adds a dataset to a project's staging area (from a csv)."""
+        return self.client.add_dataset(*args, project_id=self.id, **kwargs)
 
     def add_dataframe(self, *args, **kwargs):
-        return self.client.add_dataframe(
-            *args, project_id=self.id, task_type=tasks.TaskType(self.taskType), **kwargs
-        )
+        """Adds a dataset to a project's staging area (from a pandas DataFrame)."""
+        return self.client.add_dataframe(*args, project_id=self.id, **kwargs)
 
     def commit(self, *args, **kwargs):
+        """Adds a commit message to staged resources."""
         return self.client.commit(*args, project_id=self.id, **kwargs)
 
     def push(self, *args, **kwargs):
+        """Pushes the commited resources to the platform."""
         return self.client.push(*args, project_id=self.id, **kwargs)
 
     def status(self, *args, **kwargs):
+        """Shows the state of the staging area."""
         return self.client.status(*args, project_id=self.id, **kwargs)
 
     def restore(self, *args, **kwargs):
+        """Removes the resource specified by ``resource_name`` from the staging area."""
         return self.client.restore(*args, project_id=self.id, **kwargs)

openlayer/utils.py

@@ -1,3 +1,6 @@
+"""Series of helper functions and classes that are used throughout the
+OpenLayer Python client.
+"""
 import os
 import sys
 import traceback
@@ -38,7 +41,7 @@ def write_python_version(directory: str):
     Args:
         directory (str): the directory to write the file to.
     """
-    with open(f"{directory}/python_version", "w") as file:
+    with open(f"{directory}/python_version", "w", encoding="UTF-8") as file:
         file.write(
             str(sys.version_info.major)
             + "."
@@ -67,7 +70,7 @@ def read_yaml(filename: str) -> dict:
     Returns:
         dict: the dictionary representation of the YAML file.
     """
-    with open(filename, "r") as stream:
+    with open(filename, "r", encoding="UTF-8") as stream:
         return yaml.safe_load(stream)
 
 
@@ -78,7 +81,7 @@ def write_yaml(dictionary: dict, filename: str):
         dictionary (dict): the dictionary to write to a YAML file.
         dir (str): the directory to write the file to.
     """
-    with open(filename, "w") as stream:
+    with open(filename, "w", encoding="UTF-8") as stream:
         yaml.dump(dictionary, stream)
 
 
@@ -108,4 +111,4 @@ def list_resources_in_bundle(bundle_path: str) -> list:
     for resource in os.listdir(bundle_path):
         if resource in VALID_RESOURCES:
             resources.append(resource)
-    return resources
+    return resources