RBTools 4.0__tar.gz → 5.0__tar.gz

{RBTools-4.0 → RBTools-5.0}/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.1
 Name: RBTools
-Version: 4.0
+Version: 5.0
 Summary: Command line tools and API for working with code and document reviews on Review Board
 Home-page: https://www.reviewboard.org/downloads/rbtools/
-Download-URL: https://downloads.reviewboard.org/releases/RBTools/4.0/
+Download-URL: https://downloads.reviewboard.org/releases/RBTools/5.0/
 Author: Beanbag, Inc.
 Author-email: reviewboard@googlegroups.com
 License: MIT
@@ -16,17 +16,27 @@ Classifier: Natural Language :: English
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.7
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Software Development
 Classifier: Topic :: Software Development :: Quality Assurance
 Requires-Python: >=3.7
 Description-Content-Type: text/markdown
 License-File: COPYING
 License-File: AUTHORS
+Requires-Dist: certifi>=2023.5.7
+Requires-Dist: colorama
+Requires-Dist: housekeeping~=1.1
+Requires-Dist: packaging>=21.3
+Requires-Dist: pydiffx~=1.1.0
+Requires-Dist: texttable
+Requires-Dist: typing_extensions>=4.3.0
+Requires-Dist: tqdm
+Requires-Dist: importlib-metadata>=5.0
+Requires-Dist: importlib-resources>=5.9
 
 About RBTools
 =============

{RBTools-4.0 → RBTools-5.0}/RBTools.egg-info/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.1
 Name: RBTools
-Version: 4.0
+Version: 5.0
 Summary: Command line tools and API for working with code and document reviews on Review Board
 Home-page: https://www.reviewboard.org/downloads/rbtools/
-Download-URL: https://downloads.reviewboard.org/releases/RBTools/4.0/
+Download-URL: https://downloads.reviewboard.org/releases/RBTools/5.0/
 Author: Beanbag, Inc.
 Author-email: reviewboard@googlegroups.com
 License: MIT
@@ -16,17 +16,27 @@ Classifier: Natural Language :: English
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.7
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Software Development
 Classifier: Topic :: Software Development :: Quality Assurance
 Requires-Python: >=3.7
 Description-Content-Type: text/markdown
 License-File: COPYING
 License-File: AUTHORS
+Requires-Dist: certifi>=2023.5.7
+Requires-Dist: colorama
+Requires-Dist: housekeeping~=1.1
+Requires-Dist: packaging>=21.3
+Requires-Dist: pydiffx~=1.1.0
+Requires-Dist: texttable
+Requires-Dist: typing_extensions>=4.3.0
+Requires-Dist: tqdm
+Requires-Dist: importlib-metadata>=5.0
+Requires-Dist: importlib-resources>=5.9
 
 About RBTools
 =============

{RBTools-4.0 → RBTools-5.0}/RBTools.egg-info/SOURCES.txt

@@ -4,7 +4,6 @@ INSTALL
 MANIFEST.in
 NEWS
 README.md
-pytest.ini
 setup.cfg
 setup.py
 RBTools.egg-info/PKG-INFO
@@ -13,12 +12,10 @@ RBTools.egg-info/dependency_links.txt
 RBTools.egg-info/entry_points.txt
 RBTools.egg-info/requires.txt
 RBTools.egg-info/top_level.txt
-contrib/P4Tool.txt
-contrib/README.P4Tool
+contrib/P4V/README.md
 contrib/installers/windows/scripts/get-version.py
 rbtools/__init__.py
 rbtools/deprecation.py
-rbtools/tests.py
 rbtools/api/__init__.py
 rbtools/api/cache.py
 rbtools/api/capabilities.py
@@ -93,13 +90,27 @@ rbtools/commands/setup_repo.py
 rbtools/commands/stamp.py
 rbtools/commands/status.py
 rbtools/commands/status_update.py
-rbtools/commands/conf/_rbt-zsh-completion
-rbtools/commands/conf/rbt-bash-completion
+rbtools/commands/base/__init__.py
+rbtools/commands/base/commands.py
+rbtools/commands/base/errors.py
+rbtools/commands/base/options.py
+rbtools/commands/base/output.py
+rbtools/commands/conf/completions/bash
+rbtools/commands/conf/completions/zsh
 rbtools/commands/tests/__init__.py
 rbtools/commands/tests/test_alias.py
+rbtools/commands/tests/test_base_output.py
 rbtools/commands/tests/test_main.py
 rbtools/commands/tests/test_post.py
+rbtools/commands/tests/test_setup_completion.py
 rbtools/commands/tests/test_setup_repo.py
+rbtools/config/__init__.py
+rbtools/config/config.py
+rbtools/config/errors.py
+rbtools/config/loader.py
+rbtools/config/tests/__init__.py
+rbtools/config/tests/test_config.py
+rbtools/config/tests/test_loader.py
 rbtools/diffs/__init__.py
 rbtools/diffs/writers.py
 rbtools/diffs/tests/__init__.py
@@ -132,6 +143,7 @@ rbtools/testing/api/transport.py
 rbtools/utils/__init__.py
 rbtools/utils/aliases.py
 rbtools/utils/appdirs.py
+rbtools/utils/browser.py
 rbtools/utils/checks.py
 rbtools/utils/commands.py
 rbtools/utils/console.py
@@ -140,21 +152,24 @@ rbtools/utils/encoding.py
 rbtools/utils/errors.py
 rbtools/utils/filesystem.py
 rbtools/utils/graphs.py
-rbtools/utils/match_score.py
+rbtools/utils/mimetypes.py
 rbtools/utils/process.py
 rbtools/utils/repository.py
 rbtools/utils/review_request.py
 rbtools/utils/source_tree.py
 rbtools/utils/streams.py
-rbtools/utils/testbase.py
 rbtools/utils/users.py
+rbtools/utils/web_login.py
 rbtools/utils/tests/__init__.py
 rbtools/utils/tests/test_aliases.py
 rbtools/utils/tests/test_buffered_iterator.py
 rbtools/utils/tests/test_checks.py
 rbtools/utils/tests/test_console.py
+rbtools/utils/tests/test_encoding.py
 rbtools/utils/tests/test_filesystem.py
+rbtools/utils/tests/test_mimetypes.py
 rbtools/utils/tests/test_process.py
 rbtools/utils/tests/test_repository.py
 rbtools/utils/tests/test_review_request.py
-rbtools/utils/tests/test_source_tree.py
+rbtools/utils/tests/test_source_tree.py
+rbtools/utils/tests/test_web_login.py

RBTools-5.0/RBTools.egg-info/requires.txt

@@ -0,0 +1,10 @@
+certifi>=2023.5.7
+colorama
+housekeeping~=1.1
+packaging>=21.3
+pydiffx~=1.1.0
+texttable
+typing_extensions>=4.3.0
+tqdm
+importlib-metadata>=5.0
+importlib-resources>=5.9

RBTools-5.0/contrib/P4V/README.md

@@ -0,0 +1,49 @@
+P4V Custom Tools for RBTools
+============================
+
+This directory contains custom tools for integrating RBTools into
+[P4V](https://www.perforce.com/downloads/helix-visual-client-p4v). Once
+installed, you can right-click on a changeset and post it for review to Review
+Board.
+
+
+Installation
+------------
+
+1. Make sure that `p4` and `rbt` are available in your system path.
+
+   You may need to restart P4V if it was opened when installing RBTools.
+
+2. Download the correct P4V configuration for your configuration:
+
+    **Windows:**
+    [P4V-Windows-RBTools-Install.xml](P4V-Windows-RBTools-Install.xml)
+
+    **macOS / Linux:**
+    [P4V-Mac-Linux-Tools-Import.xml](P4V-Mac-Linux-Tools-Import.xml)
+
+3. In P4V, go to **Tools -> Manage Tools -> Custom Tools** and click
+   **Import Custom Tools...**
+
+4. Select the downloaded file and confirm.
+
+You should now be set!
+
+
+**Note:** These configurations are defaults. Depending on your system, you may
+have to adjust the paths in your custom tools (found in **Tools -> Manage Tools
+-> Custom Tools**).
+
+
+Usage
+-----
+
+1. Right-click a change to post for review.
+
+2. Click **Review Board - Post for Review**.
+
+   This can be used to create a new review request or update an existing one.
+
+3. A browser window should open to the review request.
+
+For more information, see [Using RBTools with Perforce](https://www.reviewboard.org/docs/rbtools/latest/workflows/perforce/).

{RBTools-4.0 → RBTools-5.0}/contrib/installers/windows/scripts/get-version.py

@@ -1,5 +1,3 @@
-from __future__ import print_function, unicode_literals
-
 from rbtools import VERSION
 
 

{RBTools-4.0 → RBTools-5.0}/rbtools/__init__.py

@@ -10,7 +10,7 @@ Beanbag Tools. They're largely used for packaging purposes.
 #:
 #: (Major, Minor, Micro, Patch, alpha/beta/rc/final, Release Number, Released)
 #:
-VERSION = (4, 0, 0, 0, 'final', 0, True)
+VERSION = (5, 0, 0, 0, 'final', 0, True)
 
 
 def get_version_string():

{RBTools-4.0 → RBTools-5.0}/rbtools/api/cache.py

@@ -1,3 +1,7 @@
+"""Caching implementation for the RBTools API."""
+
+from __future__ import annotations
+
 import contextlib
 import datetime
 import json
@@ -8,20 +12,23 @@ import sqlite3
 import threading
 from email.message import Message
 from http.client import HTTPResponse
-from typing import Callable, Dict, List, MutableMapping, Optional, Union
+from typing import Dict, List, MutableMapping, Optional, Union
 from urllib.request import urlopen, Request
 
 from rbtools.api.errors import CacheError
-from rbtools.deprecation import RemovedInRBTools50Warning
 from rbtools.utils.appdirs import user_cache_dir
 
 
-MINIMUM_VERSION = '2.0.14'  # Minimum server version to enable the API cache.
+#: The minimum version of Review Board to allow HTTP caching.
+#:
+#: Versions prior to this had broken caching. If this version or older is
+#: encountered, caching will be disabled.
+MINIMUM_VERSION = '2.0.14'
 
 _locale_lock = threading.Lock()  # Lock for getting / setting locale.
 
 
-class CacheEntry(object):
+class CacheEntry:
     """An entry in the API Cache."""
 
     DATE_FORMAT = '%Y-%m-%dT%H:%M:%S'  # ISO Date format
@@ -106,6 +113,10 @@ class CacheEntry(object):
     def up_to_date(self) -> bool:
         """Determine if the cache entry is up to date.
 
+        Version Changed:
+            4.1:
+            This now returns ``False`` if ``max_age`` is not available.
+
         Returns:
             bool:
             ``True`` if the cache entry is still valid. ``False``, otherwise.
@@ -114,10 +125,10 @@ class CacheEntry(object):
             max_age = datetime.timedelta(seconds=self.max_age)
             return self.local_date + max_age > datetime.datetime.now()
 
-        return True
+        return False
 
 
-class LiveHTTPResponse(object):
+class LiveHTTPResponse:
     """An uncached HTTP response that can be read() more than once.
 
     This is intended to be API-compatible with an
@@ -137,7 +148,7 @@ class LiveHTTPResponse(object):
             response (http.client.HTTPResponse):
                 The response from the server.
         """
-        self.headers = response.info()
+        self.headers = response.headers
         self.content = response.read()
         self.status = response.status
 
@@ -150,22 +161,6 @@ class LiveHTTPResponse(object):
         """
         return self.status
 
-    def info(self) -> Message:
-        """Return the headers associated with the response.
-
-        Deprecated:
-            4.0:
-            Deprecated in favor of the :py:attr:`headers` attribute.
-
-        Returns:
-            email.message.Message:
-            The response headers.
-        """
-        RemovedInRBTools50Warning.warn(
-            'LiveHTTPResponse.info() is deprecated and will be removed in '
-            'RBTools 5.0. Use LiveHTTPResponse.headers instead.')
-        return self.headers
-
     def read(self) -> bytes:
         """Return the content associated with the response.
 
@@ -175,24 +170,8 @@ class LiveHTTPResponse(object):
         """
         return self.content
 
-    def getcode(self) -> int:
-        """Return the associated HTTP response code.
-
-        Deprecated:
-            4.0:
-            Deprecated in favor of the :py:attr:`code` attribute.
-
-        Returns:
-            int:
-            The HTTP response code.
-        """
-        RemovedInRBTools50Warning.warn(
-            'LiveHTTPResponseInfo.getcode() is deprecated and will be removed '
-            'in RBTools 5.0. Use LiveHTTPResponse.code instead.')
-        return self.status
 
-
-class CachedHTTPResponse(object):
+class CachedHTTPResponse:
     """A response returned from the APICache.
 
     This is intended to be API-compatible with a urllib response object.
@@ -225,22 +204,6 @@ class CachedHTTPResponse(object):
         """
         return self.status
 
-    def info(self) -> dict:
-        """Return the headers associated with the response.
-
-        Deprecated:
-            4.0:
-            Deprecated in favor of the :py:attr:`headers` attribute.
-
-        Returns:
-            dict:
-            The cached response headers.
-        """
-        RemovedInRBTools50Warning.warn(
-            'CachedHTTPResponse.info() is deprecated and will be removed in '
-            'RBTools 5.0. Use CachedHTTPResponse.headers instead.')
-        return self.headers
-
     def read(self) -> bytes:
         """Return the content associated with the response.
 
@@ -250,25 +213,8 @@ class CachedHTTPResponse(object):
         """
         return self.content
 
-    def getcode(self) -> int:
-        """Return the associated HTTP response code, which is always 200.
 
-        Deprecated:
-            4.0:
-            Deprecated in favor of the :py:attr:`code` attribute.
-
-        Returns:
-            int:
-            200, always. This pretends that the response is the successful
-            result of an HTTP request.
-        """
-        RemovedInRBTools50Warning.warn(
-            'CachedHTTPResponseInfo.getcode() is deprecated and will be '
-            'removed in RBTools 5.0. Use CachedHTTPResponse.code instead.')
-        return 200
-
-
-class APICache(object):
+class APICache:
     """An API cache backed by a SQLite database."""
 
     # The format for the Expires: header. Requires an English locale.
@@ -285,7 +231,6 @@ class APICache(object):
         self,
         create_db_in_memory: bool = False,
         db_location: Optional[str] = None,
-        urlopen: Optional[Callable] = None,
     ) -> None:
         """Create a new instance of the APICache
 
@@ -304,19 +249,10 @@ class APICache(object):
             db_location (str):
                 The filename of the cache database, if using.
 
-            urlopen (callable):
-                The method to call for urlopen. This parameter has been
-                deprecated.
-
         Raises:
             CacheError:
                 The database exists but the schema could not be read.
         """
-        if urlopen is not None:
-            RemovedInRBTools50Warning.warn(
-                'The urlopen parameter to APICache is deprecated and will be '
-                'removed in RBTools 5.0.')
-
         if create_db_in_memory:
             logging.debug('Creating API cache in memory.')
 
@@ -364,17 +300,17 @@ class APICache(object):
                 # connect fails. In either case, HTTP requests can still be
                 # made, they will just passed through to the URL opener without
                 # attempting to interact with the API cache.
-                logging.warn('Could not create or access API cache "%s". Try '
-                             'running "rbt clear-cache" to clear the HTTP '
-                             'cache for the API.',
-                             self.cache_path)
+                logging.warning(
+                    'Could not create or access API cache "%s". Try running '
+                    '"rbt clear-cache" to clear the HTTP cache for the API.',
+                    self.cache_path)
 
         if self.db is not None:
             self.db.row_factory = APICache._row_factory
 
     def make_request(
         self,
-        request: Request
+        request: Request,
     ) -> Union[LiveHTTPResponse, CachedHTTPResponse]:
         """Perform the specified request.
 
@@ -413,18 +349,18 @@ class APICache(object):
 
                 response = LiveHTTPResponse(urlopen(request))
 
-                if response.getcode() == 304:
+                if response.code == 304:
                     logging.debug('Cached response for HTTP GET %s expired '
                                   'and was not modified',
                                   request.get_full_url())
                     entry.local_date = datetime.datetime.now()
                     self._save_entry(entry)
                     response = CachedHTTPResponse(entry)
-                elif 200 <= response.getcode() < 300:
+                elif 200 <= response.code < 300:
                     logging.debug('Cached response for HTTP GET %s expired '
                                   'and was modified',
                                   request.get_full_url())
-                    response_headers = response.info()
+                    response_headers = response.headers
                     cache_info = self._get_caching_info(request.headers,
                                                         response_headers)
 
@@ -456,7 +392,7 @@ class APICache(object):
                         self._delete_entry(entry)
         else:
             response = LiveHTTPResponse(urlopen(request))
-            response_headers = response.info()
+            response_headers = response.headers
 
             cache_info = self._get_caching_info(request.headers,
                                                 response_headers)
@@ -520,7 +456,7 @@ class APICache(object):
                 try:
                     # 'setlocale' requires the second parameter to be a 'str'
                     # in both Python 2.x and Python 3+.
-                    locale.setlocale(locale.LC_TIME, str('C'))
+                    locale.setlocale(locale.LC_TIME, 'C')
                     expires = datetime.datetime.strptime(expires,
                                                          self.EXPIRES_FORMAT)
 
@@ -602,7 +538,7 @@ class APICache(object):
             'max_age': max_age,
             'etag': etag,
             'last_modified': last_modified,
-            'vary_headers': vary_headers
+            'vary_headers': vary_headers,
         }
 
     def _create_schema(self) -> None:

{RBTools-4.0 → RBTools-5.0}/rbtools/api/capabilities.py

@@ -1,6 +1,6 @@
 """Review Board server capability management."""
 
-from typing import Dict
+from typing import Any, Mapping
 
 
 class Capabilities:
@@ -10,11 +10,11 @@ class Capabilities:
     #:
     #: Type:
     #:     dict
-    capabilities: Dict
+    capabilities: Mapping
 
     def __init__(
         self,
-        capabilities: Dict,
+        capabilities: Mapping,
     ) -> None:
         """Initialize the capabilities information.
 
@@ -37,17 +37,34 @@ class Capabilities:
             if the capability is set to ``False`` or is not present in the API
             capabilities.
         """
+        # If only part of a capability path is specified, we don't want to
+        # evaluate to True just because it has contents. We want to only
+        # say we have a capability if it is indeed 'True'.
+        return self.get_capability(*cap_path) is True
+
+    def get_capability(self, *cap_path) -> Any:
+        """Return the capability at the given path.
+
+        Version Added:
+            5.0
+
+        Args:
+            *cap_path (tuple of str):
+                The keys forming a path to the capability.
+
+        Returns:
+            Any:
+            The given capability setting. If not present, this will return
+            ``None``.
+        """
         caps = self.capabilities
 
         try:
             for key in cap_path:
                 caps = caps[key]
 
-            # If only part of a capability path is specified, we don't want to
-            # evaluate to True just because it has contents. We want to only
-            # say we have a capability if it is indeed 'True'.
-            return caps is True
+            return caps
         except (TypeError, KeyError):
             # The server either doesn't support the capability, or returned no
             # capabilities at all.
-            return False
+            return None

{RBTools-4.0 → RBTools-5.0}/rbtools/api/client.py

@@ -1,7 +1,7 @@
 from typing import Optional, Type
 from urllib.parse import urlparse
 
-from rbtools.api.resource import Resource
+from rbtools.api.resource import Resource, RootResource
 from rbtools.api.transport import Transport
 from rbtools.api.transport.sync import SyncTransport
 
@@ -36,6 +36,14 @@ class RBClient:
     #: Type: str
     url: str
 
+    #: The optional user agent for the client.
+    #:
+    #: Version Added:
+    #:     5.0
+    #:
+    #: Type: str
+    user_agent: Optional[str]
+
     def __init__(
         self,
         url: str,
@@ -58,15 +66,22 @@ class RBClient:
             **kwargs (dict):
                 Keyword arguments to pass to the transport.
         """
+        transport = transport_cls(url, *args, **kwargs)
+
         self.url = url
         self.domain = urlparse(url)[1]
-        self._transport = transport_cls(url, *args, **kwargs)
+        self._transport = transport
+
+        if hasattr(transport, 'server') and hasattr(transport.server, 'agent'):
+            self.user_agent = transport.server.agent
+        else:
+            self.user_agent = None
 
     def get_root(
         self,
         *args,
         **kwargs,
-    ) -> Optional[Resource]:
+    ) -> Optional[RootResource]:
         """Return the root resource of the API.
 
         Args: