Merge pull request #765 from CitrineInformatics/cleanup-teams-deprecation-warnings

Cleanup Teams deprecation warning.

Author: jspeerless

.travis.yml

@@ -2,8 +2,8 @@ language: python
 dist: bionic
 python:
 - '3.6'
-- '3.7'
-- '3.8'
+- '3.7.13'
+- '3.8.13'
 - '3.9'
 - '3.10.0'
 - '3.10.1'

src/citrine/__version__.py

@@ -1 +1 @@
-__version__ = '1.33.1'
+__version__ = '1.33.2'

src/citrine/_utils/functions.py

@@ -215,7 +215,7 @@ def format_escaped_url(
                            )
 
 
-def use_teams(alt, negate=False):
+def use_teams(alt, negate=False, deprecated=False):
     """
     Raises error with a redirect message if method is unavailable with(out) teams support.
 
@@ -235,34 +235,19 @@ def wrapper(self, *args, **kwargs):
                 if not self.session._accounts_service_v3:
                     raise NotImplementedError(f"Not available, you may be looking for {alt}")
             else:
-                if self.session._accounts_service_v3:
+                if deprecated:
+                    # If the method is just deprecated, print a warning even once they're on Teams.
+                    warn(f"This method is deprecated. Use {alt} instead.", DeprecationWarning)
+                elif self.session._accounts_service_v3:
+                    # If deprecated is false, that means it's unavailable on Teams, so error.
                     raise NotImplementedError(f"Not available, you may be looking for {alt}")
+                else:
+                    # If this user isn't on Teams, but it will be unavailable once they are, treat
+                    # it like a deprecation warning but specify it will be unavailable.
+                    warn("This method will be unavailable once Teams are released, and you will "
+                         "need to use {alt}.", DeprecationWarning)
             return f(self, *args, **kwargs)
 
         return wrapper
 
     return decorator
-
-
-def v1_deprecation_warn(
-        msg="This method will be deprecated once teams are released", warn_with_teams=False):
-    """
-    Raises deprecation warning for methods that will be unavailable with teams release.
-
-    Parameters
-    ----------
-    msg: str
-        The deprecation message that will be printed in the warning.
-    warn_with_teams: bool
-        Whether or not to keep the deprecation warning once teams are released.
-
-    """
-    def decorator(f):
-        @wraps(f)
-        def wrapper(self, *args, **kwargs):
-            if not self.session._accounts_service_v3 or warn_with_teams:
-                warn(msg, DeprecationWarning)
-            return f(self, *args, **kwargs)
-        return wrapper
-
-    return decorator

src/citrine/resources/project.py

@@ -11,7 +11,7 @@
 from citrine._rest.resource import Resource, ResourceTypeEnum
 from citrine._serialization import properties
 from citrine._session import Session
-from citrine._utils.functions import format_escaped_url, use_teams, v1_deprecation_warn
+from citrine._utils.functions import format_escaped_url, use_teams
 from citrine.exceptions import NonRetryableException, ModuleRegistrationFailedException
 from citrine.resources.api_error import ApiError
 from citrine.resources.branch import BranchCollection
@@ -317,8 +317,6 @@ def pull_in_resource(self, *, resource: Resource):
         return True
 
     @use_teams("team.share")
-    @v1_deprecation_warn("This method will be deprecated with the Team's release. \
-        Once Teams are released, use team.share")
     def share(self, *,
               resource: Optional[Resource] = None,
               project_id: Optional[Union[str, UUID]] = None,
@@ -360,7 +358,6 @@ def share(self, *,
         })
 
     @use_teams("project.publish")
-    @v1_deprecation_warn()
     def transfer_resource(self, *, resource: Resource,
                           receiving_project_uid: Union[str, UUID]) -> bool:
         """
@@ -394,8 +391,6 @@ def transfer_resource(self, *, resource: Resource,
         return True
 
     @use_teams("project.publish")
-    @v1_deprecation_warn("This method will be deprecated with the Team's release. \
-        Once Teams are released, use project.publish")
     def make_public(self, resource: Resource) -> bool:
         """
         Grant public access to a resource owned by this project.
@@ -421,8 +416,6 @@ def make_public(self, resource: Resource) -> bool:
         return True
 
     @use_teams("project.un_publish")
-    @v1_deprecation_warn("This method will be deprecated with the Team's release. \
-        Once Teams are released, use project.un_publish")
     def make_private(self, resource: Resource) -> bool:
         """
         Remove public access for a resource owned by this project.
@@ -511,8 +504,7 @@ def owned_table_config_ids(self) -> List[str]:
         result = self.session.get_resource(f"{self._path()}/table_definition_ids")
         return result["table_definition_ids"]
 
-    @v1_deprecation_warn("This method will be deprecated with the Team's release. \
-        Once Teams are released, use team.list_members", True)
+    @use_teams("team.list_members", deprecated=True)
     def list_members(self) -> Union[List[ProjectMember], List["TeamMember"]]:
         """
         List all of the members in the current project.
@@ -538,8 +530,6 @@ def list_members(self) -> Union[List[ProjectMember], List["TeamMember"]]:
                     for m in members]
 
     @use_teams("team.update_user_action")
-    @v1_deprecation_warn("This method will be deprecated with the Team's release. \
-        Once Teams are released, use team.update_user_action")
     def update_user_role(self, *, user_uid: Union[str, UUID], role: ROLES, actions: ACTIONS = []):
         """
         Update a User's role and action permissions in the Project.
@@ -559,8 +549,6 @@ def update_user_role(self, *, user_uid: Union[str, UUID], role: ROLES, actions:
         return True
 
     @use_teams("team.add_user")
-    @v1_deprecation_warn("This method will be deprecated with the Team's release. \
-        Once Teams are released, use team.add_user")
     def add_user(self, user_uid: Union[str, UUID]):
         """
         Add a User to a Project.
@@ -579,8 +567,6 @@ def add_user(self, user_uid: Union[str, UUID]):
         return True
 
     @use_teams("team.remove_user")
-    @v1_deprecation_warn("This method will be deprecated with the Team's release. \
-        Once Teams are released, use team.remove_user")
     def remove_user(self, user_uid: Union[str, UUID]) -> bool:
         """
         Remove a User from a Project.
@@ -697,8 +683,7 @@ def _register_in_team(self, name: str, *, description: Optional[str] = None):
         except NonRetryableException as e:
             raise ModuleRegistrationFailedException(project.__class__.__name__, e)
 
-    @v1_deprecation_warn("This method will be deprecated with the Team's release. \
-        Once Teams are released, use team.projects.register", True)
+    @use_teams("team.projects.register", deprecated=True)
     def register(self, name: str, *, description: Optional[str] = None) -> Project:
         """
         Create and upload new project.

src/citrine/seeding/find_or_create.py

@@ -1,10 +1,12 @@
+from copy import deepcopy
+
+from deprecation import deprecated
+
 from citrine.exceptions import NotFound
 from citrine.resources import ProjectCollection
 from citrine.resources.dataset import Dataset
 from citrine.informatics.workflows.design_workflow import DesignWorkflow
 from citrine._rest.collection import CreationType, Collection
-from copy import deepcopy
-from warnings import warn
 
 
 def find_collection(*, collection, name):
@@ -68,15 +70,14 @@ def get_by_name_or_raise_error(*, collection, name):
         raise ValueError("Did not find resource with the given name: {}".format(name))
 
 
+@deprecated(deprecated_in="1.33.1", removed_in="2.0.0", details="This method will be unreliable "
+            "once Teams are released, at which point you should use find_or_create_team.")
 def find_or_create_project(*, project_collection, project_name, raise_error=False):
     """
     Tries to find a project by name (returns first hit).
 
     If not found, creates a new project with the given name
     """
-    warn("This method will be deprecated with the Team's release. \
-        Once Teams are released, use find_or_create_team", DeprecationWarning)
-
     if raise_error:
         project = get_by_name_or_raise_error(collection=project_collection, name=project_name)
     else: