add pydocstyle

Author: danabens

.github/workflows/test_release.yml

@@ -27,6 +27,8 @@ jobs:
         run: tox -e black-check
       - name: Pylint
         run: tox -e pylint
+      - name: Docstyle
+        run: tox -e docstyle
 
   test:
     runs-on: ubuntu-latest

.pydocstylerc

@@ -0,0 +1,3 @@
+[pydocstyle]
+inherit = false
+ignore = D104,D107,D202,D203,D205,D209,D212,D213,D214,D400,D401,D404,D406,D407,D411,D413,D414,D415,D417

src/smexperiments/_environment.py

@@ -10,9 +10,7 @@
 
 
 class EnvironmentType(enum.Enum):
-    """
-    SageMaker jobs which data can be pulled from the environment.
-    """
+    """SageMaker jobs which data can be pulled from the environment."""
 
     SageMakerTrainingJob = 1
     SageMakerProcessingJob = 2

src/smexperiments/api_types.py

@@ -104,6 +104,7 @@ def __init__(self, string_value=None, number_value=None, **kwargs):
         )
 
     def __str__(self):
+        """String representation of TrialComponentParameterValue"""
         if self.string_value is not None:
             return self.string_value
         if self.number_value is not None:

src/smexperiments/metrics.py

@@ -10,6 +10,7 @@
 # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
 # ANY KIND, either express or implied. See the License for the specific
 # language governing permissions and limitations under the License.
+"""Metrics module"""
 import datetime
 import json
 import logging

src/smexperiments/search_expression.py

@@ -17,6 +17,8 @@
 
 @unique
 class Operator(Enum):
+    """Search operators"""
+    
     EQUALS = "Equals"
     NOT_EQUALS = "NotEquals"
     GREATER_THAN = "GreaterThan"
@@ -30,19 +32,22 @@ class Operator(Enum):
 
 @unique
 class BooleanOperator(Enum):
+    """Boolean search operation enum"""
+    
     AND = "And"
     OR = "Or"
 
 
 class SearchObject(ApiObject):
+    """SearchObject"""
+    
     def to_boto(self):
+        """Convert a search object to boto"""
         return ApiObject.to_boto(self)
 
 
 class Filter(SearchObject):
-    """
-    A Python class represent a Search Filter object.
-    """
+    """A Python class represent a Search Filter object."""
 
     name = None
     operator = None
@@ -62,9 +67,7 @@ def __init__(self, name, operator=None, value=None):
 
 
 class NestedFilter(SearchObject):
-    """
-    A Python class represent a Nested Filter object.
-    """
+    """A Python class represent a Nested Filter object."""
 
     nested_property_name = None
     filters = None

src/smexperiments/tracker.py

@@ -298,13 +298,15 @@ def log_metric(self, metric_name, value, timestamp=None, iteration_number=None):
                 raise
 
     def __enter__(self):
+        """Updates the start time of the tracked trial component."""
         self._start_time = datetime.datetime.now(dateutil.tz.tzlocal())
         if not self._in_sagemaker_job:
             self.trial_component.start_time = self._start_time
             self.trial_component.status = api_types.TrialComponentStatus(primary_status="InProgress")
         return self
 
     def __exit__(self, exc_type, exc_value, exc_traceback):
+        """Updates the end time of the tracked trial component."""
         self._end_time = datetime.datetime.now(dateutil.tz.tzlocal())
         if not self._in_sagemaker_job:
             self.trial_component.end_time = self._end_time

src/smexperiments/training_job.py

@@ -16,6 +16,8 @@
 
 
 class TrainingJob(_base_types.Record):
+    """Search for training jobs"""
+    
     @classmethod
     def search(
         cls,

tox.ini

@@ -134,4 +134,10 @@ deps =
 passenv =
     CODECOV_UPLOAD_TOKEN
 commands =
-    codecov -t {env:CODECOV_UPLOAD_TOKEN:}
+    codecov -t {env:CODECOV_UPLOAD_TOKEN:}
+    
+    
+[testenv:docstyle]
+deps = pydocstyle
+commands = 
+    pydocstyle src/smexperiments