René's URL Explorer Experiment

{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"[RFC] Rust name or Python name?","articleBody":"## Summary\r\n\r\nThis is only about python objects like `#[pymodule]`, `#[pyclass]`, `#[pyfunction]`, `#[pymethod]` and `#[pyproperty]`.\r\nSometimes python names are not fit for rust naming convention.\r\n\r\n1. Though we can specify the name with `(name = \"\")` attributes, we also need to decide how we give names for its rust side API.\r\n2. There are also python names conflict to rust keywords. They also need a special rule because we normally cannot name them same in Rust.\r\n\r\n## Detailed Explanation\r\n\r\nList of unmatching names.\r\n\r\n1. Python type `int` is type `PyInt` in Rust API.\r\n2. Python function `posix.WIFSIGNALED` is `posix::wifsignaled` in Rust.\r\n3. Python type `_struct.error` is PyTypeRef object `pystruct::error_type` in Rust.\r\n4. Python type `_weakref.ReferenceType` is a function returning PyTypeRef `_weakref::reference_type` in Rust.\r\n4. Python variable `sys.api_version` is const `sys::API_VERSION` in Rust.\r\n5. Python variable `dis.COMPILER_FLAG_NAMES` is a function returning PyDictRef `dis::compiler_flag_names` in Rust.\r\n\r\nWe must handle types differently.\r\nFor example, we can expose `\u0026PyTypeRef` for `builtins::int()` but `PyInt` through `builtins::PyInt`.\r\n\r\nWe can choose one of these kind of options for other names:\r\n1. Strictly follow Python names unless it is impossible.\r\n  - The names will not conflict.\r\n  - Some names will be `r#` prefixed in Rust. They would need human-friendly aliases.\r\n2. Follow Python names as much as possible but with exceptions by its paired Rust type.\r\n  - For example, `_weakref.ReferenceType` and `int` are both type in Python but `PyTypeRef` instance and `PyInt` struct for each in Rust. Similar for sys.api_version and dis.COMPILER_FLAG_NAMES\r\n3. Export a python-name aliased module separately. This can be generated by `derive` macros.\r\n  - For this choice, we can optionally suggest more consistency.\r\n    1. We can expose variable always through a function call. A function to return a const will be generated.\r\n    2. We can attach emitted `vm` parameter again to functions.\r\n  - Still types will be problem.\r\n\r\nList of keyword conflict.\r\n1. `struct` module.\r\n  - The exact python name is `_struct`\r\n2. `mod` operator.\r\n  - The exact python name is `__mod__`\r\n3. `match` function.\r\n4. `type` type.\r\n5. `enum` module.\r\n\r\nList of confusing non-keyword names.\r\n1. `bool` types\r\n2. `str` types\r\n3. `Iterator` for python and rust\r\n\r\nExample of solutions\r\n1. Always keep python name using `r#`. But allow alias.\r\n2. Add additional `_` suffix for conflicting type. `match` will be `match_`. But allow `r#` alias.\r\n3. Add `py` prefix like current `pybool`, `pytype`, `pystruct`.\r\n\r\n\u003c!-- Elaborate on your suggestion in all its details --\u003e\r\n\r\n## Drawbacks, Rationale, and Alternatives\r\n\r\n\u003c!-- What drawbacks might this solution have? Why do you feel it is necessary? What other options might there be to solving this problem? --\u003e\r\n\r\n## Unresolved Questions\r\n\r\n\u003c!-- What would you like feedback on for fleshing out your suggestion? --\u003e\r\nEverything. Any dicision will give concrete idea about public API design.","author":{"url":"https://github.com/youknowone","@type":"Person","name":"youknowone"},"datePublished":"2021-10-12T20:08:11.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":1},"url":"https://github.com/3284/RustPython/issues/3284"}