Define constants for month numbers in calendar module

stoneleaf · April 25, 2023, 2:27pm

Issue updated.

hugovk · April 25, 2023, 2:30pm

Yes, I linked to some above:

And:

I think people see things without leading underscores and quite reasonably think they’re public and use them.

oscarbenjamin · April 25, 2023, 2:58pm

Maybe someone could send a PR to jsonargparse.

I don’t think that lack of underscores makes it “reasonable” to import anything from anywhere. I wish there was a consensus that __all__ defines what is public. The underscore convention affects import * when __all__ is not used. When __all__ is used it should denote what is public.

EDIT: The actual code using this in json_argparse is just in the tests and even has a type: ignore which is presumably because mypy/pyright complains about using a name that is not exposed in __all__:

github.com

omni-us/jsonargparse/blob/bc1eb84c9b01a227a60fe1fd31d91bc7d4f4d333/jsonargparse_tests/test_signatures.py#L8


      
          #!/usr/bin/env python3
          
          import json
          import os
          import textwrap
          import unittest
          import warnings
          from calendar import Calendar, January  # type: ignore
          from contextlib import redirect_stderr, redirect_stdout
          from enum import Enum
          from io import StringIO
          from pathlib import Path
          from typing import Any, Dict, List, Optional, Tuple, Union
          
          import yaml
          
          from jsonargparse import (
              ActionConfigFile,

stoneleaf · April 25, 2023, 3:24pm

The are only two times when that is reasonable:

no __all__ is defined; or
the object in question is shown as public in the documentation

Well, that’s how Python treats it, so those who use Python would do well to also treat it like that.