Better dynamic enum generation, with support for docs and introspecti…

…on (#207)

src/python_pachyderm/__init__.py

@@ -59,10 +59,7 @@ def import_item(g, module, key):
 
         if isinstance(value, _EnumTypeWrapper):
             # Dynamically define an enum class that is exported
-            enum_values = _enum._EnumDict()
-            enum_values.update(dict(value.items()))
-            enum_class = type(key, (_enum.IntEnum,), enum_values)
-            g[key] = enum_class
+            g[key] = _enum.Enum(key, {k: v for (k, v) in value.items()})
         else:
             # Export the value
             g[key] = value

src/python_pachyderm/mixin/auth.py

@@ -142,8 +142,8 @@ def authorize(self, repo, scope):
 
         * `repo`: A string specifying the repo name that the caller wants
         access to.
-        * `scope`: A `Scope` object specifying the access level that the
-        caller needs to perform an action.
+        * `scope`: An int specifying the access level that the caller needs to
+        perform an action. See the `Scope` enum for variants.
         """
         return self._req(Service.AUTH, "Authorize", repo=repo, scope=scope).authorized
 
@@ -184,8 +184,8 @@ def set_scope(self, username, repo, scope):
         no ":"), then it's assumed to be a github user's principal.
         * `repo`: A string specifying the object to which `username`s access
         level is being granted/revoked.
-        * `scope`: A `Scope` object specifying the access level that
-        `username` will now have.
+        * `scope`: An int specifying the access level that `username` will now
+        have. See the `Scope` enum for variants.
         """
         return self._req(Service.AUTH, "SetScope", username=username, repo=repo, scope=scope)
 

src/python_pachyderm/mixin/pfs.py

@@ -236,8 +236,8 @@ def inspect_commit(self, commit, block_state=None):
 
         * `commit`: A tuple, string, or `Commit` object representing the
         commit.
-        * `block_state`: Causes inspect commit to block until the commit is in
-        the desired commit state.
+        * An optional int that causes this method to block until the commit is
+        in the desired commit state. See the `CommitState` enum.
         """
         return self._req(Service.PFS, "InspectCommit", commit=commit_from(commit), block_state=block_state)
 

tests/test_auth.py

@@ -56,7 +56,7 @@ def test_one_time_password():
 @util.skip_if_no_enterprise()
 def test_authorize():
     with sandbox() as client:
-        assert client.authorize("foobar", python_pachyderm.Scope.READER)
+        assert client.authorize("foobar", python_pachyderm.Scope.READER.value)
 
 @util.skip_if_no_enterprise()
 def test_who_am_i():
@@ -70,10 +70,10 @@ def test_scope():
     with sandbox() as client:
         repo = util.create_test_repo(client, "test_scope")
         scopes = client.get_scope("robot:root", repo)
-        assert all(s == python_pachyderm.Scope.NONE for s in scopes)
-        client.set_scope("robot:root", repo, python_pachyderm.Scope.READER)
+        assert all(s == python_pachyderm.Scope.NONE.value for s in scopes)
+        client.set_scope("robot:root", repo, python_pachyderm.Scope.READER.value)
         scopes = client.get_scope("robot:root", repo)
-        assert all(s == python_pachyderm.Scope.NONE for s in scopes)
+        assert all(s == python_pachyderm.Scope.NONE.value for s in scopes)
 
 @util.skip_if_no_enterprise()
 def test_acl():
@@ -82,7 +82,7 @@ def verify_acl(client, repo):
         assert len(acl.entries) == 1
         assert len(acl.robot_entries) == 0
         assert acl.entries[0].username == "robot:root"
-        assert acl.entries[0].scope == python_pachyderm.Scope.OWNER
+        assert acl.entries[0].scope == python_pachyderm.Scope.OWNER.value
         return acl
 
     with sandbox() as client:

tests/test_enterprise.py

@@ -14,5 +14,5 @@
 def test_enterprise():
     client = python_pachyderm.Client()
     client.activate_enterprise(os.environ["PACH_PYTHON_ENTERPRISE_CODE"])
-    assert client.get_enterprise_state().state == python_pachyderm.State.ACTIVE
+    assert client.get_enterprise_state().state == python_pachyderm.State.ACTIVE.value
     client.deactivate_enterprise()

tests/test_pfs.py

@@ -399,10 +399,10 @@ def test_list_file():
     files = list(client.list_file(c, '/'))
     assert len(files) == 2
     assert files[0].size_bytes == 4
-    assert files[0].file_type == python_pachyderm.FileType.FILE
+    assert files[0].file_type == python_pachyderm.FileType.FILE.value
     assert files[0].file.path == "/file1.dat"
     assert files[1].size_bytes == 4
-    assert files[1].file_type == python_pachyderm.FileType.FILE
+    assert files[1].file_type == python_pachyderm.FileType.FILE.value
     assert files[1].file.path == "/file2.dat"
 
 def test_walk_file():
@@ -430,16 +430,16 @@ def test_glob_file():
     files = list(client.glob_file(c, '/*.dat'))
     assert len(files) == 2
     assert files[0].size_bytes == 4
-    assert files[0].file_type == python_pachyderm.FileType.FILE
+    assert files[0].file_type == python_pachyderm.FileType.FILE.value
     assert files[0].file.path == "/file1.dat"
     assert files[1].size_bytes == 4
-    assert files[1].file_type == python_pachyderm.FileType.FILE
+    assert files[1].file_type == python_pachyderm.FileType.FILE.value
     assert files[1].file.path == "/file2.dat"
 
     files = list(client.glob_file(c, '/*1.dat'))
     assert len(files) == 1
     assert files[0].size_bytes == 4
-    assert files[0].file_type == python_pachyderm.FileType.FILE
+    assert files[0].file_type == python_pachyderm.FileType.FILE.value
     assert files[0].file.path == "/file1.dat"
 
 def test_delete_file():

tests/test_pps.py

@@ -59,15 +59,15 @@ def test_stop_job():
     except:
         # if it failed, it should be because the job already finished
         job = sandbox.client.inspect_job(job_id)
-        assert job.state == python_pachyderm.JobState.JOB_SUCCESS
+        assert job.state == python_pachyderm.JobState.JOB_SUCCESS.value
     else:
         # This is necessary because `StopJob` does not wait for the job to be
         # killed before returning a result.
         # TODO: remove once this is fixed:
         # https://github.com/pachyderm/pachyderm/issues/3856
         time.sleep(1)
         job = sandbox.client.inspect_job(job_id)
-        assert job.state == python_pachyderm.JobState.JOB_KILLED
+        assert job.state == python_pachyderm.JobState.JOB_KILLED.value
 
 def test_delete_job():
     sandbox = Sandbox("delete_job")
@@ -86,7 +86,7 @@ def test_datums():
     datums = list(sandbox.client.list_datum(job_id))
     assert len(datums) == 1
     datum = sandbox.client.inspect_datum(job_id, datums[0].datum_info.datum.id)
-    assert datum.state == python_pachyderm.DatumState.SUCCESS
+    assert datum.state == python_pachyderm.DatumState.SUCCESS.value
 
     # Skip this check in >=1.11.0, due to a bug:
     # https://github.com/pachyderm/pachyderm/issues/5123

tests/util.py

@@ -64,7 +64,7 @@ def create_test_pipeline(client, test_name):
 
 def wait_for_job(client, commit):
     # block until the commit is ready
-    client.inspect_commit(commit, block_state=python_pachyderm.CommitState.READY)
+    client.inspect_commit(commit, block_state=python_pachyderm.CommitState.READY.value)
 
     # while the commit is ready, the job might not be listed on the first
     # call, so repeatedly list jobs until it's available