fix python binding's entry point

Author: 2bndy5

bindings/node/README.md

@@ -58,10 +58,11 @@ This script runs a simple test to ensure the native module was built correctly.
 | `build.rs` | The cargo-specific build script used when compiling the binding. |
 | `Cargo.toml` | Metadata about the binding's rust package (which _is not_ intended to be published to crates.io). |
 | `package.json` | Metadata about the npm package (platform agnostic). |
+| `cli.js` | The executable script invoked as a Command Line Interface. |
 | `index.d.ts` | The generated TypeScript typing info the describes the exposing functionality in the built native module. |
 | `index.js` | The generated script that delegates which platform-specific package to import. |
 | `cpp-linter.x-y-z.node` | Then native module built for a specific platform (where `x-y-z` denotes the platform's name using compilation target). |
 
 Hidden files and folders are not described in the table above.
 If they are not ignored by a gitignore specification, then they should be considered
-important for maintenance or distribution.
+important only for maintenance or distribution.

bindings/python/README.md

@@ -46,12 +46,12 @@ cpp-linter -help
 
 | Name | Description |
 |-----:|:------------|
-| `cpp_linter` | The pure python sources that wrap the rust binding. Typing information is located here. |
 | `src` | The location for all rust sources related to binding the cpp-linter library. |
 | `Cargo.toml` | Metadata about the binding's rust package (which _is not_ intended to be published to crates.io). |
+| `../../cpp_linter.pyi` | The typing stubs for the package (located in repo root). |
 | `../../pyproject.toml` | Metadata about the python package (located in repo root). |
 | `requirements-dev.txt` | The dependencies used in development (not needed for runtime/production). |
 
 Hidden files and folders are not described in the table above.
 If they are not ignored by a gitignore specification, then they should be considered
-important for maintenance or distribution.
+important only for maintenance or distribution.

bindings/python/cpp_linter/__init__.py

@@ -1,11 +1,15 @@
 use pyo3::{exceptions::PyOSError, prelude::*};
+use std::env;
 use tokio::runtime::Builder;
 
 use ::cpp_linter::run::run_main;
 
 /// A wrapper for the ``::cpp_linter::run::run_main()```
 #[pyfunction]
-fn main(args: Vec<String>) -> PyResult<()> {
+#[pyo3(signature = (args = None))]
+fn main(args: Option<Vec<String>>) -> PyResult<()> {
+    // exclude path to python interpreter
+    let args = args.unwrap_or(env::args().collect::<Vec<String>>()[1..].to_vec());
     Builder::new_multi_thread()
         .enable_all()
         .build()

bindings/python/cpp_linter/cpp_linter.pyi

@@ -32,10 +32,13 @@ fn probe_ssl_certs() {
 /// The idea here is that all functionality is implemented in Rust. However, passing
 /// command line arguments is done differently in Python, node.js, or Rust.
 ///
-/// - In python, the `sys.argv` list is passed from the `cpp_linter.main()`
-///   function to rust via the `cpp_linter.main()` binding (which wraps [`run_main()`]).
-/// - In node.js, the `process.argv` array is passed from `cli.js` module to
-///   rust via `index.node` module's `main()` (which wraps([`run_main()`])).
+/// - In python, the CLI arguments list is optionally passed to the binding's
+///   `cpp_linter.main()` function (which wraps [`run_main()`]). If no args are passed,
+///   then `cpp_linter.main()` uses [`std::env::args`] without the leading path to the
+///   python interpreter removed.
+/// - In node.js, the `process.argv` array (without the leading path to the node
+///   interpreter removed) is passed from `cli.js` module to rust via `index.node`
+///   module's `main()` (which wraps([`run_main()`])).
 /// - In rust, the [`std::env::args`] is passed to [`run_main()`] in the binary
 ///   source `main.rs`.
 ///

bindings/python/cpp_linter/py.typed

@@ -0,0 +1 @@
+def main(args: list[str] | None = None) -> int: ...