| FazBrowse GitHub Viewer | Trending | | Home |
| Tools: [Download Repo ZIP] [Original HTTPS Page] |
1 parent 74b68e9 commit 133271b
1 file changed
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -105,7 +105,7 @@ def handle_process_output( | |||
| 105 | 105 | ) -> None: | |
| 106 | 106 | """Registers for notifications to learn that process output is ready to read, and dispatches lines to | |
| 107 | 107 | the respective line handlers. | |
| 108 | - This function returns once the finalizer returns | ||
| 108 | + This function returns once the finalizer returns. | ||
| 109 | 109 | ||
| 110 | 110 | :return: result of finalizer | |
| 111 | 111 | :param process: subprocess.Popen instance | |
@@ -294,9 +294,7 @@ def __setstate__(self, d: Dict[str, Any]) -> None: | |||
| 294 | 294 | ||
| 295 | 295 | @classmethod | |
| 296 | 296 | def refresh(cls, path: Union[None, PathLike] = None) -> bool: | |
| 297 | - """This gets called by the refresh function (see the top level | ||
| 298 | - __init__). | ||
| 299 | - """ | ||
| 297 | + """This gets called by the refresh function (see the top level __init__).""" | ||
| 300 | 298 | # discern which path to refresh with | |
| 301 | 299 | if path is not None: | |
| 302 | 300 | new_git = os.path.expanduser(path) | |
@@ -446,9 +444,9 @@ def polish_url(cls, url: str, is_cygwin: Union[None, bool] = None) -> PathLike: | |||
| 446 | 444 | if is_cygwin: | |
| 447 | 445 | url = cygpath(url) | |
| 448 | 446 | else: | |
| 449 | - """Remove any backslahes from urls to be written in config files. | ||
| 447 | + """Remove any backslashes from urls to be written in config files. | ||
| 450 | 448 | ||
| 451 | - Windows might create config-files containing paths with backslashed, | ||
| 449 | + Windows might create config files containing paths with backslashes, | ||
| 452 | 450 | but git stops liking them as it will escape the backslashes. | |
| 453 | 451 | Hence we undo the escaping just to be sure. | |
| 454 | 452 | """ | |
@@ -464,8 +462,8 @@ def check_unsafe_protocols(cls, url: str) -> None: | |||
| 464 | 462 | Check for unsafe protocols. | |
| 465 | 463 | ||
| 466 | 464 | Apart from the usual protocols (http, git, ssh), | |
| 467 | - Git allows "remote helpers" that have the form `<transport>::<address>`, | ||
| 468 | - one of these helpers (`ext::`) can be used to invoke any arbitrary command. | ||
| 465 | + Git allows "remote helpers" that have the form ``<transport>::<address>``, | ||
| 466 | + one of these helpers (``ext::``) can be used to invoke any arbitrary command. | ||
| 469 | 467 | ||
| 470 | 468 | See: | |
| 471 | 469 | ||
@@ -517,7 +515,7 @@ def __init__(self, proc: Union[None, subprocess.Popen], args: Any) -> None: | |||
| 517 | 515 | self.status: Union[int, None] = None | |
| 518 | 516 | ||
| 519 | 517 | def _terminate(self) -> None: | |
| 520 | - """Terminate the underlying process""" | ||
| 518 | + """Terminate the underlying process.""" | ||
| 521 | 519 | if self.proc is None: | |
| 522 | 520 | return | |
| 523 | 521 | ||
@@ -572,7 +570,7 @@ def wait(self, stderr: Union[None, str, bytes] = b"") -> int: | |||
| 572 | 570 | """Wait for the process and return its status code. | |
| 573 | 571 | ||
| 574 | 572 | :param stderr: Previously read value of stderr, in case stderr is already closed. | |
| 575 | - :warn: may deadlock if output or error pipes are used and not handled separately. | ||
| 573 | + :warn: May deadlock if output or error pipes are used and not handled separately. | ||
| 576 | 574 | :raise GitCommandError: if the return status is not 0""" | |
| 577 | 575 | if stderr is None: | |
| 578 | 576 | stderr_b = b"" | |
@@ -605,13 +603,12 @@ def read_all_from_possibly_closed_stream(stream: Union[IO[bytes], None]) -> byte | |||
| 605 | 603 | # END auto interrupt | |
| 606 | 604 | ||
| 607 | 605 | class CatFileContentStream(object): | |
| 608 | - | ||
| 609 | 606 | """Object representing a sized read-only stream returning the contents of | |
| 610 | 607 | an object. | |
| 611 | 608 | It behaves like a stream, but counts the data read and simulates an empty | |
| 612 | 609 | stream once our sized content region is empty. | |
| 613 | - If not all data is read to the end of the objects's lifetime, we read the | ||
| 614 | - rest to assure the underlying stream continues to work""" | ||
| 610 | + If not all data is read to the end of the object's lifetime, we read the | ||
| 611 | + rest to assure the underlying stream continues to work.""" | ||
| 615 | 612 | ||
| 616 | 613 | __slots__: Tuple[str, ...] = ("_stream", "_nbr", "_size") | |
| 617 | 614 | ||
@@ -740,11 +737,11 @@ def __getattr__(self, name: str) -> Any: | |||
| 740 | 737 | ||
| 741 | 738 | def set_persistent_git_options(self, **kwargs: Any) -> None: | |
| 742 | 739 | """Specify command line options to the git executable | |
| 743 | - for subsequent subcommand calls | ||
| 740 | + for subsequent subcommand calls. | ||
| 744 | 741 | ||
| 745 | 742 | :param kwargs: | |
| 746 | 743 | is a dict of keyword arguments. | |
| 747 | - these arguments are passed as in _call_process | ||
| 744 | + These arguments are passed as in _call_process | ||
| 748 | 745 | but will be passed to the git command rather than | |
| 749 | 746 | the subcommand. | |
| 750 | 747 | """ | |
@@ -775,7 +772,7 @@ def version_info(self) -> Tuple[int, int, int, int]: | |||
| 775 | 772 | """ | |
| 776 | 773 | :return: tuple(int, int, int, int) tuple with integers representing the major, minor | |
| 777 | 774 | and additional version numbers as parsed from git version. | |
| 778 | - This value is generated on demand and is cached""" | ||
| 775 | + This value is generated on demand and is cached.""" | ||
| 779 | 776 | return self._version_info | |
| 780 | 777 | ||
| 781 | 778 | @overload | |
@@ -843,7 +840,7 @@ def execute( | |||
| 843 | 840 | **subprocess_kwargs: Any, | |
| 844 | 841 | ) -> Union[str, bytes, Tuple[int, Union[str, bytes], str], AutoInterrupt]: | |
| 845 | 842 | """Handles executing the command and consumes and returns the returned | |
| 846 | - information (stdout) | ||
| 843 | + information (stdout). | ||
| 847 | 844 | ||
| 848 | 845 | :param command: | |
| 849 | 846 | The command argument list to execute. | |
@@ -1213,7 +1210,7 @@ def _unpack_args(cls, arg_list: Sequence[str]) -> List[str]: | |||
| 1213 | 1210 | ||
| 1214 | 1211 | def __call__(self, **kwargs: Any) -> "Git": | |
| 1215 | 1212 | """Specify command line options to the git executable | |
| 1216 | - for a subcommand call | ||
| 1213 | + for a subcommand call. | ||
| 1217 | 1214 | ||
| 1218 | 1215 | :param kwargs: | |
| 1219 | 1216 | is a dict of keyword arguments. | |
@@ -1251,7 +1248,7 @@ def _call_process( | |||
| 1251 | 1248 | self, method: str, *args: Any, **kwargs: Any | |
| 1252 | 1249 | ) -> Union[str, bytes, Tuple[int, Union[str, bytes], str], "Git.AutoInterrupt"]: | |
| 1253 | 1250 | """Run the given git command with the specified arguments and return | |
| 1254 | - the result as a String | ||
| 1251 | + the result as a string. | ||
| 1255 | 1252 | ||
| 1256 | 1253 | :param method: | |
| 1257 | 1254 | is the command. Contained "_" characters will be converted to dashes, | |
@@ -1260,7 +1257,7 @@ def _call_process( | |||
| 1260 | 1257 | :param args: | |
| 1261 | 1258 | is the list of arguments. If None is included, it will be pruned. | |
| 1262 | 1259 | This allows your commands to call git more conveniently as None | |
| 1263 | - is realized as non-existent | ||
| 1260 | + is realized as non-existent. | ||
| 1264 | 1261 | ||
| 1265 | 1262 | :param kwargs: | |
| 1266 | 1263 | It contains key-values for the following: | |
@@ -1390,7 +1387,7 @@ def get_object_header(self, ref: str) -> Tuple[str, str, int]: | |||
| 1390 | 1387 | return self.__get_object_header(cmd, ref) | |
| 1391 | 1388 | ||
| 1392 | 1389 | def get_object_data(self, ref: str) -> Tuple[str, str, int, bytes]: | |
| 1393 | - """As get_object_header, but returns object data as well | ||
| 1390 | + """As get_object_header, but returns object data as well. | ||
| 1394 | 1391 | ||
| 1395 | 1392 | :return: (hexsha, type_string, size_as_int, data_string) | |
| 1396 | 1393 | :note: not threadsafe""" | |
@@ -1400,10 +1397,10 @@ def get_object_data(self, ref: str) -> Tuple[str, str, int, bytes]: | |||
| 1400 | 1397 | return (hexsha, typename, size, data) | |
| 1401 | 1398 | ||
| 1402 | 1399 | def stream_object_data(self, ref: str) -> Tuple[str, str, int, "Git.CatFileContentStream"]: | |
| 1403 | - """As get_object_header, but returns the data as a stream | ||
| 1400 | + """As get_object_header, but returns the data as a stream. | ||
| 1404 | 1401 | ||
| 1405 | 1402 | :return: (hexsha, type_string, size_as_int, stream) | |
| 1406 | - :note: This method is not threadsafe, you need one independent Command instance per thread to be safe !""" | ||
| 1403 | + :note: This method is not threadsafe, you need one independent Command instance per thread to be safe!""" | ||
| 1407 | 1404 | cmd = self._get_persistent_cmd("cat_file_all", "cat_file", batch=True) | |
| 1408 | 1405 | hexsha, typename, size = self.__get_object_header(cmd, ref) | |
| 1409 | 1406 | cmd_stdout = cmd.stdout if cmd.stdout is not None else io.BytesIO() | |
| Back | FazBrowse Home | New Git URL |
0 commit comments