return back resource class container_* attributes

Author: maxtepkeev

CHANGELOG.rst

@@ -36,6 +36,8 @@ Changelog
   over the uploading process if needed
 - Removed ``resource_paths`` argument from Redmine object since ``ResourceManager`` now uses a special resource
   registry, to which, all resources that inherit from any Python-Redmine resource are being automatically added
+- Removed ``container_many`` in favor of ``container_filter``, ``container_create`` and ``container_update``
+  attributes on ``Resource`` object to allow more fine-grained resource setup
 
 **Bugfixes**:
 

redminelib/__init__.py

@@ -164,10 +164,12 @@ def search(self, query, **options):
 
         for name, details in resources.registry.items():
             if details['class'].search_hints is not None:
+                container = details['class'].container_all or details['class'].container_filter
+
                 for hint in details['class'].search_hints:
-                    container_map[hint] = details['class'].container_many
+                    container_map[hint] = container
 
-                manager_map[details['class'].container_many] = getattr(self, name)
+                manager_map[container] = getattr(self, name)
 
         raw_resources, _ = self.engine.bulk_request('get', '{0}/search.json'.format(self.url), 'results', **options)
 

redminelib/managers.py

@@ -117,12 +117,12 @@ def all(self, **params):
 
         :param dict params: (optional). Parameters used for resources retrieval.
         """
-        if self.resource_class.query_all is None or self.resource_class.container_many is None:
+        if self.resource_class.query_all is None or self.resource_class.container_all is None:
             raise exceptions.ResourceBadMethodError
 
         self.url = self.redmine.url + self.resource_class.query_all
         self.params = self.resource_class.bulk_decode(params, self)
-        self.container = self.resource_class.container_many
+        self.container = self.resource_class.container_all
         return resultsets.ResourceSet(self)
 
     def filter(self, **filters):
@@ -131,15 +131,15 @@ def filter(self, **filters):
 
         :param dict filters: (optional). Filters used for resources retrieval.
         """
-        if self.resource_class.query_filter is None or self.resource_class.container_many is None:
+        if self.resource_class.query_filter is None or self.resource_class.container_filter is None:
             raise exceptions.ResourceBadMethodError
 
         if not filters:
             raise exceptions.ResourceNoFiltersProvidedError
 
         try:
             self.url = self.redmine.url + self.resource_class.query_filter.format(**filters)
-            self.container = self.resource_class.container_many.format(**filters)
+            self.container = self.resource_class.container_filter.format(**filters)
         except KeyError:
             raise exceptions.ResourceFilterError
 
@@ -152,7 +152,7 @@ def create(self, **fields):
 
         :param dict fields: (optional). Fields used for resource creation.
         """
-        if self.resource_class.query_create is None or self.resource_class.container_one is None:
+        if self.resource_class.query_create is None or self.resource_class.container_create is None:
             raise exceptions.ResourceBadMethodError
 
         if not fields:
@@ -165,8 +165,8 @@ def create(self, **fields):
         except KeyError as exception:
             raise exceptions.ValidationError('{0} field is required'.format(exception))
 
-        self.container = self.resource_class.container_one
-        data = {self.resource_class.container_one: self.resource_class.bulk_decode(formatter.unused_kwargs, self)}
+        self.container = self.resource_class.container_create
+        data = {self.resource_class.container_create: self.resource_class.bulk_decode(formatter.unused_kwargs, self)}
         response = self.redmine.engine.request(self.resource_class.http_method_create, url, data=data)
 
         try:
@@ -186,7 +186,7 @@ def update(self, resource_id, **fields):
         :type resource_id: int or string
         :param dict fields: (optional). Fields which will be updated for the resource.
         """
-        if self.resource_class.query_update is None or self.resource_class.container_one is None:
+        if self.resource_class.query_update is None or self.resource_class.container_update is None:
             raise exceptions.ResourceBadMethodError
 
         if not fields:
@@ -206,7 +206,7 @@ def update(self, resource_id, **fields):
                 raise exceptions.ValidationError('{0} argument is required'.format(exception))
 
         url = self.redmine.url + query_update
-        data = {self.resource_class.container_one: self.resource_class.bulk_decode(formatter.unused_kwargs, self)}
+        data = {self.resource_class.container_update: self.resource_class.bulk_decode(formatter.unused_kwargs, self)}
         return self.redmine.engine.request(self.resource_class.http_method_update, url, data=data)
 
     def delete(self, resource_id, **params):
@@ -235,11 +235,12 @@ def search(self, query, **options):
         :param string query: (required). What to search.
         :param dict options: (optional). Dictionary of search options.
         """
-        if self.resource_class.search_hints is None or self.resource_class.container_many is None:
+        if self.resource_class.search_hints is None:
             raise exceptions.ResourceBadMethodError
 
-        results = self.redmine.search(query, **dict(resources=[self.resource_class.container_many], **options))
-        return results.get(self.resource_class.container_many) if results is not None else results
+        container = self.resource_class.container_all or self.resource_class.container_filter
+        results = self.redmine.search(query, **dict(resources=[container], **options))
+        return results.get(container) if results is not None else results
 
     def __repr__(self):
         """

redminelib/resources/base.py

@@ -83,8 +83,11 @@ class BaseResource(utilities.with_metaclass(Registrar)):
     internal_id_key = 'id'
     redmine_version = None
     requirements = []
-    container_many = None
+    container_all = None
     container_one = None
+    container_filter = None
+    container_create = None
+    container_update = None
     query_all_export = None
     query_one_export = None
     query_all = None

redminelib/resources/standard.py

@@ -12,8 +12,10 @@
 
 class Project(BaseResource):
     redmine_version = '1.0'
-    container_many = 'projects'
+    container_all = 'projects'
     container_one = 'project'
+    container_create = 'project'
+    container_update = 'project'
     query_all_export = '/projects.{format}'
     query_all = '/projects.json'
     query_one = '/projects/{0}.json'
@@ -55,8 +57,11 @@ def encode(cls, attr, value, manager):
 
 class Issue(BaseResource):
     redmine_version = '1.0'
-    container_many = 'issues'
+    container_all = 'issues'
     container_one = 'issue'
+    container_filter = 'issues'
+    container_create = 'issue'
+    container_update = 'issue'
     query_all_export = '/issues.{format}'
     query_one_export = '/issues/{0}.{format}'
     query_all = '/issues.json?status_id=*'
@@ -162,8 +167,11 @@ def decode(cls, attr, value, manager):
 
 class TimeEntry(BaseResource):
     redmine_version = '1.1'
-    container_many = 'time_entries'
+    container_all = 'time_entries'
     container_one = 'time_entry'
+    container_filter = 'time_entries'
+    container_create = 'time_entry'
+    container_update = 'time_entry'
     query_all_export = '/time_entries.{format}'
     query_all = '/time_entries.json'
     query_one = '/time_entries/{0}.json'
@@ -189,7 +197,7 @@ def decode(cls, attr, value, manager):
 
 class Enumeration(BaseResource):
     redmine_version = '2.2'
-    container_many = '{resource}'
+    container_filter = '{resource}'
     query_filter = '/enumerations/{resource}.json'
 
     _resource_set_map = {'custom_fields': 'CustomField'}
@@ -202,6 +210,7 @@ def url(self):
 class Attachment(BaseResource):
     redmine_version = '1.3'
     container_one = 'attachment'
+    container_update = 'attachment'
     query_one = '/attachments/{0}.json'
     query_update = '/attachments/{0}.json'
     query_delete = '/attachments/{0}.json'
@@ -225,8 +234,10 @@ class IssueJournal(BaseResource):
 class WikiPage(BaseResource):
     internal_id_key = 'title'
     redmine_version = '2.2'
-    container_many = 'wiki_pages'
+    container_filter = 'wiki_pages'
     container_one = 'wiki_page'
+    container_create = 'wiki_page'
+    container_update = 'wiki_page'
     query_one_export = '/projects/{project_id}/wiki/{0}.{format}'
     query_filter = '/projects/{project_id}/wiki/index.json'
     query_one = '/projects/{project_id}/wiki/{0}.json'
@@ -288,8 +299,10 @@ def __int__(self):
 
 class ProjectMembership(BaseResource):
     redmine_version = '1.4'
-    container_many = 'memberships'
+    container_filter = 'memberships'
     container_one = 'membership'
+    container_update = 'membership'
+    container_create = 'membership'
     query_filter = '/projects/{project_id}/memberships.json'
     query_one = '/memberships/{0}.json'
     query_create = '/projects/{project_id}/memberships.json'
@@ -307,8 +320,10 @@ class ProjectMembership(BaseResource):
 
 class IssueCategory(BaseResource):
     redmine_version = '1.3'
-    container_many = 'issue_categories'
+    container_filter = 'issue_categories'
     container_one = 'issue_category'
+    container_update = 'issue_category'
+    container_create = 'issue_category'
     query_filter = '/projects/{project_id}/issue_categories.json'
     query_one = '/issue_categories/{0}.json'
     query_create = '/projects/{project_id}/issue_categories.json'
@@ -320,8 +335,9 @@ class IssueCategory(BaseResource):
 
 class IssueRelation(BaseResource):
     redmine_version = '1.3'
-    container_many = 'relations'
+    container_filter = 'relations'
     container_one = 'relation'
+    container_create = 'relation'
     query_filter = '/issues/{issue_id}/relations.json'
     query_one = '/relations/{0}.json'
     query_create = '/issues/{issue_id}/relations.json'
@@ -333,8 +349,10 @@ class IssueRelation(BaseResource):
 
 class Version(BaseResource):
     redmine_version = '1.3'
-    container_many = 'versions'
+    container_filter = 'versions'
     container_one = 'version'
+    container_create = 'version'
+    container_update = 'version'
     query_filter = '/projects/{project_id}/versions.json'
     query_one = '/versions/{0}.json'
     query_create = '/projects/{project_id}/versions.json'
@@ -349,8 +367,11 @@ class Version(BaseResource):
 
 class User(BaseResource):
     redmine_version = '1.1'
-    container_many = 'users'
+    container_all = 'users'
     container_one = 'user'
+    container_filter = 'users'
+    container_create = 'user'
+    container_update = 'user'
     query_all = '/users.json'
     query_one = '/users/{0}.json'
     query_filter = '/users.json'
@@ -385,8 +406,10 @@ def __getattr__(self, attr):
 
 class Group(BaseResource):
     redmine_version = '2.1'
-    container_many = 'groups'
+    container_all = 'groups'
     container_one = 'group'
+    container_create = 'group'
+    container_update = 'group'
     query_all = '/groups.json'
     query_one = '/groups/{0}.json'
     query_create = '/groups.json'
@@ -432,15 +455,16 @@ def __getattr__(self, attr):
 
 class Role(BaseResource):
     redmine_version = '1.4'
-    container_many = 'roles'
+    container_all = 'roles'
     container_one = 'role'
     query_all = '/roles.json'
     query_one = '/roles/{0}.json'
 
 
 class News(BaseResource):
     redmine_version = '1.1'
-    container_many = 'news'
+    container_all = 'news'
+    container_filter = 'news'
     query_all_export = '/news.{format}'
     query_all = '/news.json'
     query_filter = '/news.json'
@@ -456,7 +480,7 @@ def url(self):
 
 class IssueStatus(BaseResource):
     redmine_version = '1.3'
-    container_many = 'issue_statuses'
+    container_all = 'issue_statuses'
     query_all = '/issue_statuses.json'
 
     _relations = ['issues']
@@ -470,7 +494,7 @@ def url(self):
 
 class Tracker(BaseResource):
     redmine_version = '1.3'
-    container_many = 'trackers'
+    container_all = 'trackers'
     query_all = '/trackers.json'
 
     _relations = ['issues']
@@ -483,7 +507,7 @@ def url(self):
 
 class Query(BaseResource):
     redmine_version = '1.3'
-    container_many = 'queries'
+    container_all = 'queries'
     query_all = '/queries.json'
 
     @property
@@ -494,7 +518,7 @@ def url(self):
 
 class CustomField(BaseResource):
     redmine_version = '2.4'
-    container_many = 'custom_fields'
+    container_all = 'custom_fields'
     query_all = '/custom_fields.json'
 
     _resource_set_map = {'trackers': 'Tracker', 'roles': 'Role'}