From 41b33e9209577761e471f055bba9d41746d98059 Mon Sep 17 00:00:00 2001 From: Josh Soref <2119212+jsoref@users.noreply.github.com> Date: Tue, 6 Feb 2024 14:21:28 -0500 Subject: [PATCH 01/17] spelling: asynchronously Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com> --- tests/timeline.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tests/timeline.md b/tests/timeline.md index 8b77e30e9..eedafd79e 100644 --- a/tests/timeline.md +++ b/tests/timeline.md @@ -43,7 +43,7 @@ A *timeline* is a sequence of [occurrences](#Occurrence), in order in which they A timeline can be grown by recording new occurrences in it. This is done automatically by the test infrastructure for requests, responses and events occurring in a debug session. Marks are recorded with the `timeline.mark(id)` method, which returns the recorded mark occurrence. It is not possible to "rewrite the history" - once recorded, occurrences can never be forgotten, and do not change. -Timelines are completely thread-safe for both recording and inspection. However, because a timeline during an active debug session can grow asyncronously as new events and responses are received, it cannot be inspected directly, other than asking for the last occurrence via `timeline.last()` - which is a function rather than a property, indicating that it may return a different value on every subsequent call. +Timelines are completely thread-safe for both recording and inspection. However, because a timeline during an active debug session can grow asynchronously as new events and responses are received, it cannot be inspected directly, other than asking for the last occurrence via `timeline.last()` - which is a function rather than a property, indicating that it may return a different value on every subsequent call. It is, however, possible to take a snapshot of a timeline via `timeline.history()`; the returned value is a list of all occurrences that were in the timeline at the point of the call, in order from first to last. This is just a shortcut for `reversed(list(timeline.last()))`. From 00d5c14810119b2486bafd7a40181d3e04112be3 Mon Sep 17 00:00:00 2001 From: Josh Soref <2119212+jsoref@users.noreply.github.com> Date: Tue, 6 Feb 2024 14:22:04 -0500 Subject: [PATCH 02/17] spelling: communicate Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com> --- tests/DEBUGGEE_PYTHONPATH/debuggee/backchannel.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tests/DEBUGGEE_PYTHONPATH/debuggee/backchannel.py b/tests/DEBUGGEE_PYTHONPATH/debuggee/backchannel.py index 714856e55..a1a8768df 100644 --- a/tests/DEBUGGEE_PYTHONPATH/debuggee/backchannel.py +++ b/tests/DEBUGGEE_PYTHONPATH/debuggee/backchannel.py @@ -3,7 +3,7 @@ # for license information. """Imported from test code that runs under debugpy, and allows that code -to communcate back to the test. Works in conjunction with debug_session +to communicate back to the test. Works in conjunction with debug_session fixture and its backchannel method.""" __all__ = ["port", "receive", "send"] From 859129363de3dce79c71ae603b086100844de70f Mon Sep 17 00:00:00 2001 From: Josh Soref <2119212+jsoref@users.noreply.github.com> Date: Tue, 6 Feb 2024 14:22:13 -0500 Subject: [PATCH 03/17] spelling: component Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com> --- src/debugpy/adapter/sessions.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/debugpy/adapter/sessions.py b/src/debugpy/adapter/sessions.py index ca87483f8..71e5b14d3 100644 --- a/src/debugpy/adapter/sessions.py +++ b/src/debugpy/adapter/sessions.py @@ -40,7 +40,7 @@ def __init__(self): """The client component. Always present.""" self.launcher = components.missing(self, launchers.Launcher) - """The launcher componet. Always present in "launch" sessions, and never + """The launcher component. Always present in "launch" sessions, and never present in "attach" sessions. """ From 0f5eff214bd8d9e196887067d8353302da6933c2 Mon Sep 17 00:00:00 2001 From: Josh Soref <2119212+jsoref@users.noreply.github.com> Date: Tue, 6 Feb 2024 14:22:20 -0500 Subject: [PATCH 04/17] spelling: conjunction Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com> --- tests/timeline.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tests/timeline.md b/tests/timeline.md index eedafd79e..aa5b173dc 100644 --- a/tests/timeline.md +++ b/tests/timeline.md @@ -187,7 +187,7 @@ assert ( ) in debug_session.timeline ``` -### Conjuction (`&`) +### Conjunction (`&`) When two expectations are conjuncted: `(A & B)` - the resulting expectation is realized at the occurrence at which `A` and `B` are both realized, regardless of their relative order. Thus: ```py From 0a6831649495ba8a09a20680701ecc761856958f Mon Sep 17 00:00:00 2001 From: Josh Soref <2119212+jsoref@users.noreply.github.com> Date: Tue, 6 Feb 2024 14:22:31 -0500 Subject: [PATCH 05/17] spelling: conversion Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com> --- tests/debugpy/common/test_messaging.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tests/debugpy/common/test_messaging.py b/tests/debugpy/common/test_messaging.py index 335a5ead8..8ac3af45f 100644 --- a/tests/debugpy/common/test_messaging.py +++ b/tests/debugpy/common/test_messaging.py @@ -666,7 +666,7 @@ def test_str_to_num(self): for val_trial, type_trial in correct_trials: assert isinstance( json.of_type(type_trial)(val_trial), type_trial - ), "Wrong type coversion" + ), "Wrong type conversion" # test conversion that are not expected to work try: From f498e87b0407cb269a16a26ac18cff808e9dafa1 Mon Sep 17 00:00:00 2001 From: Josh Soref <2119212+jsoref@users.noreply.github.com> Date: Tue, 6 Feb 2024 14:22:48 -0500 Subject: [PATCH 06/17] spelling: described Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com> --- src/debugpy/common/messaging.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/debugpy/common/messaging.py b/src/debugpy/common/messaging.py index b133f71b6..f064ee6ba 100644 --- a/src/debugpy/common/messaging.py +++ b/src/debugpy/common/messaging.py @@ -974,7 +974,7 @@ class MessageHandlingError(Exception): escape the message loop unhandled, and terminate the process. If any message handler raises this exception, but applies_to(message) is False, it - is treated as if it was a generic exception, as desribed above. Thus, if a request + is treated as if it was a generic exception, as described above. Thus, if a request handler issues another request of its own, and that one fails, the failure is not silently propagated. However, a request that is delegated via Request.delegate() will also propagate failures back automatically. For manual propagation, catch the From f2d0e9abf5a10328d53a25a525e0edd2124b2457 Mon Sep 17 00:00:00 2001 From: Josh Soref <2119212+jsoref@users.noreply.github.com> Date: Tue, 6 Feb 2024 14:29:59 -0500 Subject: [PATCH 07/17] spelling: disjunction Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com> --- tests/timeline.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tests/timeline.md b/tests/timeline.md index aa5b173dc..cd8d9c732 100644 --- a/tests/timeline.md +++ b/tests/timeline.md @@ -244,7 +244,7 @@ if handled_request is pause1: ... ``` -### Exclusive disjuction (`^`) +### Exclusive disjunction (`^`) When two expectations are exclusively disjuncted: `(A ^ B)` - the resulting expectation is realized at the first occurrence at which either `A` or `B` is realized, but not both. Thus, the expectation: ```py From c609ee32b97d654c507372355f7661347456f5ff Mon Sep 17 00:00:00 2001 From: Josh Soref <2119212+jsoref@users.noreply.github.com> Date: Tue, 6 Feb 2024 14:22:58 -0500 Subject: [PATCH 08/17] spelling: doesn't Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com> --- src/debugpy/public_api.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/debugpy/public_api.py b/src/debugpy/public_api.py index 9d0f705ad..b1c153861 100644 --- a/src/debugpy/public_api.py +++ b/src/debugpy/public_api.py @@ -113,7 +113,7 @@ def listen( different from address if port was 0 in the latter, in which case the adapter will pick some unused ephemeral port to listen on. - This function does't wait for a client to connect to the debug + This function doesn't wait for a client to connect to the debug adapter that it starts. Use `wait_for_client` to block execution until the client connects. """ @@ -131,7 +131,7 @@ def connect(__endpoint: Endpoint | int, *, access_token: str | None = None) -> E `access_token` must be the same value that was passed to the adapter via the `--server-access-token` command-line switch. - This function does't wait for a client to connect to the debug + This function doesn't wait for a client to connect to the debug adapter that it connects to. Use `wait_for_client` to block execution until the client connects. """ From 3ec555cebf89014aeb2d965750ff141457da198f Mon Sep 17 00:00:00 2001 From: Josh Soref <2119212+jsoref@users.noreply.github.com> Date: Tue, 6 Feb 2024 14:03:04 -0500 Subject: [PATCH 09/17] spelling: entry Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com> --- src/debugpy/__main__.py | 2 +- src/debugpy/adapter/__main__.py | 2 +- src/debugpy/launcher/__main__.py | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/src/debugpy/__main__.py b/src/debugpy/__main__.py index 24c2b7faa..28e1eb285 100644 --- a/src/debugpy/__main__.py +++ b/src/debugpy/__main__.py @@ -17,7 +17,7 @@ # # To fix both, we need to replace the automatically added entry such that it points # at parent directory of debugpy/ instead of debugpy/ itself, import debugpy with that - # in sys.path, and then remove the first entry entry altogether, so that it doesn't + # in sys.path, and then remove the first entry altogether, so that it doesn't # affect any further imports we might do. For example, suppose the user did: # # python /foo/bar/debugpy ... diff --git a/src/debugpy/adapter/__main__.py b/src/debugpy/adapter/__main__.py index e18ecd560..6da2d412f 100644 --- a/src/debugpy/adapter/__main__.py +++ b/src/debugpy/adapter/__main__.py @@ -199,7 +199,7 @@ def _parse_argv(argv): # # To fix both, we need to replace the automatically added entry such that it points # at parent directory of debugpy/ instead of debugpy/adapter, import debugpy with that - # in sys.path, and then remove the first entry entry altogether, so that it doesn't + # in sys.path, and then remove the first entry altogether, so that it doesn't # affect any further imports we might do. For example, suppose the user did: # # python /foo/bar/debugpy/adapter ... diff --git a/src/debugpy/launcher/__main__.py b/src/debugpy/launcher/__main__.py index cff18b5f1..da50f73ef 100644 --- a/src/debugpy/launcher/__main__.py +++ b/src/debugpy/launcher/__main__.py @@ -63,7 +63,7 @@ def main(): # # To fix both, we need to replace the automatically added entry such that it points # at parent directory of debugpy/ instead of debugpy/launcher, import debugpy with that - # in sys.path, and then remove the first entry entry altogether, so that it doesn't + # in sys.path, and then remove the first entry altogether, so that it doesn't # affect any further imports we might do. For example, suppose the user did: # # python /foo/bar/debugpy/launcher ... From c027b4dc98dce1cb7d5f09f936640f1fccd7e72f Mon Sep 17 00:00:00 2001 From: Josh Soref <2119212+jsoref@users.noreply.github.com> Date: Tue, 6 Feb 2024 14:04:34 -0500 Subject: [PATCH 10/17] spelling: github Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com> --- versioneer.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/versioneer.py b/versioneer.py index 2156245ad..df95fba3b 100644 --- a/versioneer.py +++ b/versioneer.py @@ -162,7 +162,7 @@ ## Known Limitations Some situations are known to cause problems for Versioneer. This details the -most significant ones. More can be found on Github +most significant ones. More can be found on GitHub [issues page](https://github.com/python-versioneer/python-versioneer/issues). ### Subprojects From c742b20c522d8dcd0f3ca40e85c13aa7f3410bc7 Mon Sep 17 00:00:00 2001 From: Josh Soref <2119212+jsoref@users.noreply.github.com> Date: Tue, 6 Feb 2024 14:23:14 -0500 Subject: [PATCH 11/17] spelling: graceful Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com> --- src/debugpy/adapter/clients.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/debugpy/adapter/clients.py b/src/debugpy/adapter/clients.py index ee1d15145..85f1ac819 100644 --- a/src/debugpy/adapter/clients.py +++ b/src/debugpy/adapter/clients.py @@ -665,7 +665,7 @@ def terminate_request(self, request): self.restart_requested = False if self._forward_terminate_request: - # According to the spec, terminate should try to do a gracefull shutdown. + # According to the spec, terminate should try to do a graceful shutdown. # We do this in the server by interrupting the main thread with a Ctrl+C. # To force the kill a subsequent request would do a disconnect. # From c0003e240cfa25a2839d21b9f446dbfc8d33ea12 Mon Sep 17 00:00:00 2001 From: Josh Soref <2119212+jsoref@users.noreply.github.com> Date: Tue, 6 Feb 2024 14:30:26 -0500 Subject: [PATCH 12/17] spelling: occurred Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com> --- src/debugpy/common/messaging.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/debugpy/common/messaging.py b/src/debugpy/common/messaging.py index f064ee6ba..4c2e422f8 100644 --- a/src/debugpy/common/messaging.py +++ b/src/debugpy/common/messaging.py @@ -995,7 +995,7 @@ def __init__(self, reason, cause=None, silent=False): """Creates a new instance of this class, and immediately logs the exception. Message handling errors are logged immediately unless silent=True, so that the - precise context in which they occured can be determined from the surrounding + precise context in which they occurred can be determined from the surrounding log entries. """ From a653833d3d329f911d5094c69bce5c6bd034e35b Mon Sep 17 00:00:00 2001 From: Josh Soref <2119212+jsoref@users.noreply.github.com> Date: Tue, 6 Feb 2024 14:30:46 -0500 Subject: [PATCH 13/17] spelling: separate Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com> --- azure-pipelines/pipelines.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-pipelines/pipelines.yaml b/azure-pipelines/pipelines.yaml index f5c08a10a..962f1c12e 100644 --- a/azure-pipelines/pipelines.yaml +++ b/azure-pipelines/pipelines.yaml @@ -1,5 +1,5 @@ # This pipeline is used to run PR validation and CI builds against the debugpy public repo. -# Seperate internal pipelines are used for generating wheels, signing, and releasing to pypi.org +# Separate internal pipelines are used for generating wheels, signing, and releasing to pypi.org # Trigger ci builds for commits into master and any release branches trigger: From 8e50eaffed86542f58ded2016102616a489b1bae Mon Sep 17 00:00:00 2001 From: Josh Soref <2119212+jsoref@users.noreply.github.com> Date: Tue, 6 Feb 2024 14:30:56 -0500 Subject: [PATCH 14/17] spelling: something Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com> --- tests/debugpy/test_completions.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tests/debugpy/test_completions.py b/tests/debugpy/test_completions.py index eca12d98b..3cea368e6 100644 --- a/tests/debugpy/test_completions.py +++ b/tests/debugpy/test_completions.py @@ -39,13 +39,13 @@ class SomeClass: def __init__(self, someVar): self.some_var = someVar - def do_someting(self): + def do_something(self): someVariable = self.some_var return someVariable # @in_do_something def someFunction(someVar): someVariable = someVar - return SomeClass(someVariable).do_someting() # @in_some_function + return SomeClass(someVariable).do_something() # @in_some_function someFunction("value") print("done") # @done From 8cb823a91fb7c0231dec5ef6e2a20fa701150b20 Mon Sep 17 00:00:00 2001 From: Josh Soref <2119212+jsoref@users.noreply.github.com> Date: Tue, 6 Feb 2024 14:31:56 -0500 Subject: [PATCH 15/17] spelling: successful Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com> --- tests/timeline.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tests/timeline.md b/tests/timeline.md index cd8d9c732..35deb7fc0 100644 --- a/tests/timeline.md +++ b/tests/timeline.md @@ -112,7 +112,7 @@ and a further shortcut to issue a request, wait for response, and retrieve the r ```py initialize_response_body = debug_session.request('initialize', {'adapterID': 'test'}) ``` -On success, `request()` returns the body of the sucessful response directly, rather than the `Response` object. On failure, it raises the appropriate exception. +On success, `request()` returns the body of the successful response directly, rather than the `Response` object. On failure, it raises the appropriate exception. ## Expectation algebra From efa599e342881834a02ae27bf4e037053dfe518a Mon Sep 17 00:00:00 2001 From: Josh Soref <2119212+jsoref@users.noreply.github.com> Date: Tue, 6 Feb 2024 14:03:30 -0500 Subject: [PATCH 16/17] spelling: the Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com> --- SECURITY.md | 2 +- src/debugpy/adapter/components.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/SECURITY.md b/SECURITY.md index e0dfff56a..9e9391ee0 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -12,7 +12,7 @@ If you believe you have found a security vulnerability in any Microsoft-owned re Instead, please report them to the Microsoft Security Response Center (MSRC) at [https://msrc.microsoft.com/create-report](https://msrc.microsoft.com/create-report). -If you prefer to submit without logging in, send email to [secure@microsoft.com](mailto:secure@microsoft.com). If possible, encrypt your message with our PGP key; please download it from the the [Microsoft Security Response Center PGP Key page](https://www.microsoft.com/en-us/msrc/pgp-key-msrc). +If you prefer to submit without logging in, send email to [secure@microsoft.com](mailto:secure@microsoft.com). If possible, encrypt your message with our PGP key; please download it from the [Microsoft Security Response Center PGP Key page](https://www.microsoft.com/en-us/msrc/pgp-key-msrc). You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at [microsoft.com/msrc](https://www.microsoft.com/msrc). diff --git a/src/debugpy/adapter/components.py b/src/debugpy/adapter/components.py index cc88d1416..4e31248c6 100644 --- a/src/debugpy/adapter/components.py +++ b/src/debugpy/adapter/components.py @@ -134,7 +134,7 @@ class Capabilities(dict): """ PROPERTIES = {} - """JSON property names and default values for the the capabilities represented + """JSON property names and default values for the capabilities represented by instances of this class. Keys are names, and values are either default values or validators. From ea434bf9732469c4f0cb61adf63b816df55ee33a Mon Sep 17 00:00:00 2001 From: Josh Soref <2119212+jsoref@users.noreply.github.com> Date: Tue, 6 Feb 2024 14:24:35 -0500 Subject: [PATCH 17/17] spelling: written Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com> --- tests/pytest_fixtures.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tests/pytest_fixtures.py b/tests/pytest_fixtures.py index bbba2c2e7..561fd3861 100644 --- a/tests/pytest_fixtures.py +++ b/tests/pytest_fixtures.py @@ -187,7 +187,7 @@ def script_file(): that it uses locally. When linter complains, use #noqa. Returns a py.path.local instance that has the additional attribute "lines". - After the source is writen to disk, tests.code.get_marked_line_numbers() is + After the source is written to disk, tests.code.get_marked_line_numbers() is invoked on the resulting file to compute the value of that attribute. """