Merge pull request #116 from mgeisler/configparser

Add stubs for configparser

stdlib/3/configparser.pyi

@@ -0,0 +1,166 @@
+# Stubs for configparser
+
+# Based on http://docs.python.org/3.5/library/configparser.html and on
+# reading configparser.py.
+
+from typing import (MutableMapping, Mapping, Dict, Sequence, List,
+                    Iterable, Iterator, Callable, Any, TextIO)
+# Types only used in type comments only
+from typing import Optional, Tuple  # noqa
+
+# Internal type aliases
+_section = Dict[str, str]
+_parser = MutableMapping[str, _section]
+_converters = Dict[str, Callable[[str], Any]]
+
+
+DEFAULTSECT = ...  # type: str
+
+
+class Interpolation:
+    def before_get(self, parser: _parser,
+                   section: str,
+                   option: str,
+                   value: str,
+                   defaults: _section) -> str: ...
+
+    def before_set(self, parser: _parser,
+                   section: str,
+                   option: str,
+                   value: str) -> str: ...
+
+    def before_read(self, parser: _parser,
+                    section: str,
+                    option: str,
+                    value: str) -> str: ...
+
+    def before_write(self, parser: _parser,
+                     section: str,
+                     option: str,
+                     value: str) -> str: ...
+
+
+class BasicInterpolation(Interpolation):
+    pass
+
+
+class ExtendedInterpolation(Interpolation):
+    pass
+
+
+class ConfigParser(_parser):
+    def __init__(self,
+                 defaults: _section = None,
+                 dict_type: Mapping[str, str] = ...,
+                 allow_no_value: bool = ...,
+                 delimiters: Sequence[str] = ...,
+                 comment_prefixes: Sequence[str] = ...,
+                 inline_comment_prefixes: Sequence[str] = None,
+                 strict: bool = ...,
+                 empty_lines_in_values: bool = ...,
+                 default_section: str = ...,
+                 interpolation: Interpolation = None,
+                 converters: _converters = {}) -> None: ...
+
+    def __len__(self) -> int: ...
+
+    def __getitem__(self, section: str) -> _section: ...
+
+    def __setitem__(self, section: str, options: _section) -> None: ...
+
+    def __delitem__(self, section: str) -> None: ...
+
+    def __iter__(self) -> Iterator[str]: ...
+
+    def defaults(self) -> _section: ...
+
+    def sections(self) -> List[str]: ...
+
+    def add_section(self, section: str) -> None: ...
+
+    def has_section(self, section: str) -> bool: ...
+
+    def options(self, section: str) -> List[str]: ...
+
+    def has_option(self, section: str, option: str) -> bool: ...
+
+    def read(self, filenames: Sequence[str],
+             encoding: str = None) -> List[str]: ...
+
+    def read_file(self, f: Iterable[str], source: str = None) -> None: ...
+
+    def read_string(self, string: str, source: str = ...) -> None: ...
+
+    def read_dict(self, dictionary: Mapping[str, Mapping[str, Any]],
+                  source: str = ...) -> None: ...
+
+    def getint(self, section: str, option: str) -> int: ...
+
+    def getfloat(self, section: str, option: str) -> float: ...
+
+    def getboolean(self, section: str, option: str) -> bool: ...
+
+    def set(self, section: str, option: str, value: str) -> None: ...
+
+    def write(self,
+              fileobject: TextIO,
+              space_around_delimiters: bool = True) -> None: ...
+
+    def remove_option(self, section: str, option: str) -> bool: ...
+
+    def remove_section(self, section: str) -> bool: ...
+
+    def optionxform(self, option: str) -> str: ...
+
+
+class Error(Exception):
+    pass
+
+
+class NoSectionError(Error):
+    pass
+
+
+class DuplicateSectionError(Error):
+    section = ...  # type: str
+    source = ...   # type: Optional[str]
+    lineno = ...   # type: Optional[int]
+
+
+class DuplicateOptionError(Error):
+    section = ...  # type: str
+    option = ...   # type: str
+    source = ...   # type: Optional[str]
+    lineno = ...   # type: Optional[int]
+
+
+class NoOptionError(Error):
+    section = ...  # type: str
+    option = ...   # type: str
+
+
+class InterpolationError(Error):
+    section = ...  # type: str
+    option = ...   # type: str
+
+
+class InterpolationDepthError(InterpolationError):
+    pass
+
+
+class InterpolationMissingOptionError(InterpolationError):
+    reference = ...  # type: str
+
+
+class InterpolationSyntaxError(InterpolationError):
+    pass
+
+
+class ParsingError:
+    source = ...  # type: str
+    errors = ...  # type: Sequence[Tuple[int, str]]
+
+
+class MissingSectionHeaderError(ParsingError):
+    lineno = ...  # type: int
+    line = ...    # type: str