Rename the relational key builder to be a query key builder

Author: Touchstone64

plexapi/base.py

@@ -176,12 +176,11 @@ def _buildDetailsKey(self, **kwargs):
             details_key += '?' + urlencode(sorted(params.items()))
         return details_key
 
-    def _buildRelationalKey(self, key, **kwargs):
-        """ Returns a key suitable for fetching partial objects extended to
-            include relational information.
+    def _buildQueryKey(self, key, **kwargs):
+        """ Returns a query key suitable for fetching partial objects.
 
             Parameters:
-                key (str): The relational key to be fetched.
+                key (str): The key to which options should be added to form a query.
                 **kwargs (dict): Optional query parameters to add to the key, such as
                     'excludeAllLeaves=1' or 'index=0'. Additional XML filters should instead
                     be passed into search functions. See :func:`~plexapi.base.PlexObject.fetchItems`

plexapi/video.py

@@ -710,7 +710,7 @@ def season(self, title=None, season=None):
             Raises:
                 :exc:`~plexapi.exceptions.BadRequest`: If title or season parameter is missing.
         """
-        key = self._buildRelationalKey(f'{self.key}/children', excludeAllLeaves=1)
+        key = self._buildQueryKey(f'{self.key}/children', excludeAllLeaves=1)
         if title is not None and not isinstance(title, int):
             return self.fetchItem(key, Season, title__iexact=title)
         elif season is not None or isinstance(title, int):
@@ -723,7 +723,7 @@ def season(self, title=None, season=None):
 
     def seasons(self, **kwargs):
         """ Returns a list of :class:`~plexapi.video.Season` objects in the show. """
-        key = self._buildRelationalKey(f'{self.key}/children', excludeAllLeaves=1)
+        key = self._buildQueryKey(f'{self.key}/children', excludeAllLeaves=1)
         return self.fetchItems(key, Season, container_size=self.childCount, **kwargs)
 
     def episode(self, title=None, season=None, episode=None):
@@ -737,7 +737,7 @@ def episode(self, title=None, season=None, episode=None):
             Raises:
                 :exc:`~plexapi.exceptions.BadRequest`: If title or season and episode parameters are missing.
         """
-        key = self._buildRelationalKey(f'{self.key}/allLeaves')
+        key = self._buildQueryKey(f'{self.key}/allLeaves')
         if title is not None:
             return self.fetchItem(key, Episode, title__iexact=title)
         elif season is not None and episode is not None:
@@ -746,7 +746,7 @@ def episode(self, title=None, season=None, episode=None):
 
     def episodes(self, **kwargs):
         """ Returns a list of :class:`~plexapi.video.Episode` objects in the show. """
-        key = self._buildRelationalKey(f'{self.key}/allLeaves')
+        key = self._buildQueryKey(f'{self.key}/allLeaves')
         return self.fetchItems(key, Episode, **kwargs)
 
     def get(self, title=None, season=None, episode=None):
@@ -906,7 +906,7 @@ def episode(self, title=None, episode=None):
             Raises:
                 :exc:`~plexapi.exceptions.BadRequest`: If title or episode parameter is missing.
         """
-        key = self._buildRelationalKey(f'{self.key}/children')
+        key = self._buildQueryKey(f'{self.key}/children')
         if title is not None and not isinstance(title, int):
             return self.fetchItem(key, Episode, title__iexact=title)
         elif episode is not None or isinstance(title, int):
@@ -919,7 +919,7 @@ def episode(self, title=None, episode=None):
 
     def episodes(self, **kwargs):
         """ Returns a list of :class:`~plexapi.video.Episode` objects in the season. """
-        key = self._buildRelationalKey(f'{self.key}/children')
+        key = self._buildQueryKey(f'{self.key}/children')
         return self.fetchItems(key, Episode, **kwargs)
 
     def get(self, title=None, episode=None):
@@ -928,7 +928,7 @@ def get(self, title=None, episode=None):
 
     def show(self):
         """ Return the season's :class:`~plexapi.video.Show`. """
-        return self.fetchItem(self._buildRelationalKey(self.parentKey))
+        return self.fetchItem(self._buildQueryKey(self.parentKey))
 
     def watched(self):
         """ Returns list of watched :class:`~plexapi.video.Episode` objects. """
@@ -1136,7 +1136,7 @@ def parentThumb(self):
     def _season(self):
         """ Returns the :class:`~plexapi.video.Season` object by querying for the show's children. """
         if self.grandparentKey and self.parentIndex is not None:
-            key = self._buildRelationalKey(
+            key = self._buildQueryKey(
                 f'{self.grandparentKey}/children',
                 excludeAllLeaves=1,
                 index=self.parentIndex
@@ -1218,11 +1218,11 @@ def hasPreviewThumbnails(self):
 
     def season(self):
         """" Return the episode's :class:`~plexapi.video.Season`. """
-        return self.fetchItem(self._buildRelationalKey(self.parentKey))
+        return self.fetchItem(self._buildQueryKey(self.parentKey))
 
     def show(self):
         """" Return the episode's :class:`~plexapi.video.Show`. """
-        return self.fetchItem(self._buildRelationalKey(self.grandparentKey))
+        return self.fetchItem(self._buildQueryKey(self.grandparentKey))
 
     def _defaultSyncTitle(self):
         """ Returns str, default title for a new syncItem. """