Skip to content

Making add dataclass options public #60

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions argparse_dataclass.py
Original file line number Diff line number Diff line change
Expand Up @@ -298,7 +298,7 @@ def parse_args(
) -> OptionsType:
"""Parse arguments and return as the dataclass type."""
parser = argparse.ArgumentParser()
_add_dataclass_options(options_class, parser)
add_dataclass_options(options_class, parser)
kwargs = _get_kwargs(parser.parse_args(args))
return options_class(**kwargs)

Expand All @@ -310,13 +310,13 @@ def parse_known_args(
and list of remaining arguments.
"""
parser = argparse.ArgumentParser()
_add_dataclass_options(options_class, parser)
add_dataclass_options(options_class, parser)
namespace, others = parser.parse_known_args(args=args)
kwargs = _get_kwargs(namespace)
return options_class(**kwargs), others


def _add_dataclass_options(
def add_dataclass_options(
options_class: typing.Type[OptionsType], parser: argparse.ArgumentParser
) -> None:
if not is_dataclass(options_class):
Expand Down Expand Up @@ -359,7 +359,7 @@ def _add_dataclass_options(
if field.default == field.default_factory == MISSING and not positional:
kwargs["required"] = True
else:
kwargs["default"] = MISSING
kwargs["default"] = field.default
Copy link
Contributor

@jcal-15 jcal-15 Dec 10, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need to keep the default as MISSING so that the dataclass's initialization handles the default value. This is needed so default_factory can work correctly.

Also, doing it this way makes the initialization consistent with initializing the dataclass outside of the argparse_dataclass package


if field.type is bool:
_handle_bool_type(field, args, kwargs)
Expand Down Expand Up @@ -420,7 +420,7 @@ class ArgumentParser(argparse.ArgumentParser, typing.Generic[OptionsType]):
def __init__(self, options_class: typing.Type[OptionsType], *args, **kwargs):
super().__init__(*args, **kwargs)
self._options_type: typing.Type[OptionsType] = options_class
_add_dataclass_options(options_class, self)
add_dataclass_options(options_class, self)

def parse_args(self, args: ArgsType = None, namespace=None) -> OptionsType:
"""Parse arguments and return as the dataclass type."""
Expand Down
18 changes: 17 additions & 1 deletion tests/test_functional.py
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
import argparse
import sys
import unittest
import datetime as dt
from dataclasses import dataclass, field

from typing import List, Optional, Union

from argparse_dataclass import parse_args, parse_known_args
from argparse_dataclass import add_dataclass_options, parse_args, parse_known_args


class NegativeTestHelper:
Expand Down Expand Up @@ -53,6 +54,21 @@ class Opt:

self.assertRaises(TypeError, parse_args, Opt, [])

def test_add_dataclass_options(self):
@dataclass
class Opt:
x: int = 42
y: bool = False
argpument_parser = argparse.ArgumentParser()
add_dataclass_options(Opt, argpument_parser)
params = argpument_parser.parse_args([])
print(params)
self.assertEqual(42, params.x)
self.assertEqual(False, params.y)
Comment on lines +64 to +67
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

parse_args returns a namespace object not a Opt so it is not expected to have the defaults set.

params = params = argpument_parser.parse_args(["--x=10", "--y"])
self.assertEqual(10, params.x)
self.assertEqual(True, params.y)

def test_bool_no_default(self):
@dataclass
class Opt:
Expand Down