mirror of
https://github.com/pytorch/pytorch.git
synced 2025-10-20 21:14:14 +08:00
Preferring dash over underscore in command-line options. Add `--command-arg-name` to the argument parser. The old arguments with underscores `--command_arg_name` are kept for backward compatibility.
Both dashes and underscores are used in the PyTorch codebase. Some argument parsers only have dashes or only have underscores in arguments. For example, the `torchrun` utility for distributed training only accepts underscore arguments (e.g., `--master_port`). The dashes are more common in other command-line tools. And it looks to be the default choice in the Python standard library:
`argparse.BooleanOptionalAction`: 4a9dff0e5a/Lib/argparse.py (L893-L895)
```python
class BooleanOptionalAction(Action):
def __init__(...):
if option_string.startswith('--'):
option_string = '--no-' + option_string[2:]
_option_strings.append(option_string)
```
It adds `--no-argname`, not `--no_argname`. Also typing `_` need to press the shift or the caps-lock key than `-`.
Pull Request resolved: https://github.com/pytorch/pytorch/pull/94505
Approved by: https://github.com/ezyang, https://github.com/seemethere
66 lines
2.4 KiB
Python
66 lines
2.4 KiB
Python
import tempfile
|
|
import unittest
|
|
from unittest.mock import NonCallableMock, patch
|
|
|
|
import tools.jit.gen_unboxing as gen_unboxing
|
|
|
|
|
|
@patch("tools.jit.gen_unboxing.get_custom_build_selector")
|
|
@patch("tools.jit.gen_unboxing.parse_native_yaml")
|
|
@patch("tools.jit.gen_unboxing.make_file_manager")
|
|
@patch("tools.jit.gen_unboxing.gen_unboxing")
|
|
class TestGenUnboxing(unittest.TestCase):
|
|
def test_get_custom_build_selector_with_allowlist(
|
|
self,
|
|
mock_gen_unboxing: NonCallableMock,
|
|
mock_make_file_manager: NonCallableMock,
|
|
mock_parse_native_yaml: NonCallableMock,
|
|
mock_get_custom_build_selector: NonCallableMock,
|
|
) -> None:
|
|
args = ["--op-registration-allowlist=op1", "--op-selection-yaml-path=path2"]
|
|
gen_unboxing.main(args)
|
|
mock_get_custom_build_selector.assert_called_once_with(["op1"], "path2")
|
|
|
|
def test_get_custom_build_selector_with_allowlist_yaml(
|
|
self,
|
|
mock_gen_unboxing: NonCallableMock,
|
|
mock_make_file_manager: NonCallableMock,
|
|
mock_parse_native_yaml: NonCallableMock,
|
|
mock_get_custom_build_selector: NonCallableMock,
|
|
) -> None:
|
|
temp_file = tempfile.NamedTemporaryFile()
|
|
temp_file.write(b"- aten::add.Tensor")
|
|
temp_file.seek(0)
|
|
args = [
|
|
f"--TEST-ONLY-op-registration-allowlist-yaml-path={temp_file.name}",
|
|
"--op-selection-yaml-path=path2",
|
|
]
|
|
gen_unboxing.main(args)
|
|
mock_get_custom_build_selector.assert_called_once_with(
|
|
["aten::add.Tensor"], "path2"
|
|
)
|
|
temp_file.close()
|
|
|
|
def test_get_custom_build_selector_with_both_allowlist_and_yaml(
|
|
self,
|
|
mock_gen_unboxing: NonCallableMock,
|
|
mock_make_file_manager: NonCallableMock,
|
|
mock_parse_native_yaml: NonCallableMock,
|
|
mock_get_custom_build_selector: NonCallableMock,
|
|
) -> None:
|
|
temp_file = tempfile.NamedTemporaryFile()
|
|
temp_file.write(b"- aten::add.Tensor")
|
|
temp_file.seek(0)
|
|
args = [
|
|
"--op-registration-allowlist=op1",
|
|
"--TEST-ONLY-op-registration-allowlist-yaml-path={temp_file.name}",
|
|
"--op-selection-yaml-path=path2",
|
|
]
|
|
gen_unboxing.main(args)
|
|
mock_get_custom_build_selector.assert_called_once_with(["op1"], "path2")
|
|
temp_file.close()
|
|
|
|
|
|
if __name__ == "__main__":
|
|
unittest.main()
|