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/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: 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/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. # 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. 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. """ diff --git a/src/debugpy/common/messaging.py b/src/debugpy/common/messaging.py index b133f71b6..4c2e422f8 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 @@ -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. """ 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 ... 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. """ 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"] 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: 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 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. """ diff --git a/tests/timeline.md b/tests/timeline.md index 8b77e30e9..35deb7fc0 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()))`. @@ -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 @@ -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 @@ -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 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