Created pyi for SimpleHTTPServer [Python 2.7] #1186
Conversation
stdlib/2/SimpleHTTPServer.pyi
Outdated
| server_version = ... # type: str | ||
| def do_GET(self) -> None: ... | ||
| def do_HEAD(self) -> None: ... | ||
| def send_head(self) -> Optional[IO[AnyStr]]: ... |
There was a problem hiding this comment.
I think it's IO[str] (https://github.com/python/cpython/blob/2.7/Lib/SimpleHTTPServer.py#L91).
There was a problem hiding this comment.
You mean Optional[IO[str]]? Makes sense.
stdlib/2/SimpleHTTPServer.pyi
Outdated
| def do_HEAD(self) -> None: ... | ||
| def send_head(self) -> Optional[IO[AnyStr]]: ... | ||
| def list_directory(self, path: str) -> Optional[StringIO]: ... | ||
| def translate_path(self, path: str) -> str: ... |
There was a problem hiding this comment.
I think this one actually could use AnyStr.
stdlib/2/SimpleHTTPServer.pyi
Outdated
| def do_GET(self) -> None: ... | ||
| def do_HEAD(self) -> None: ... | ||
| def send_head(self) -> Optional[IO[AnyStr]]: ... | ||
| def list_directory(self, path: str) -> Optional[StringIO]: ... |
There was a problem hiding this comment.
I think the argument for this one can also be unicode.
There was a problem hiding this comment.
Changed it to AnyStr, because os.listdir takes AnyStr.
stdlib/2/SimpleHTTPServer.pyi
Outdated
| def list_directory(self, path: str) -> Optional[StringIO]: ... | ||
| def translate_path(self, path: str) -> str: ... | ||
| def copyfile(self, source: IO[AnyStr], outputfile: IO[AnyStr]): ... | ||
| def guess_type(self, path: str) -> str: ... |
There was a problem hiding this comment.
The argument (but not the return type) can also be unicode.
There was a problem hiding this comment.
So Union[str, unicode] instead of AnyStr for path? Or does it not make any difference here?
There was a problem hiding this comment.
Union[str, unicode] based on #871
stdlib/2/SimpleHTTPServer.pyi
Outdated
| def do_HEAD(self) -> None: ... | ||
| def send_head(self) -> Optional[IO[str]]: ... | ||
| def list_directory(self, path: AnyStr) -> Optional[StringIO]: ... | ||
| def translate_path(self, path: AnyStr) -> str: ... |
There was a problem hiding this comment.
The return value should also be AnyStr. In general, a single AnyStr doesn't make sense, because the point of the AnyStr type variable is to constrain two types to be the same (either str or unicode).
As far as I'm aware, using only AnyStr in a signature is meaningful only when it's the type argument to a generic class like List. In that case, List[AnyStr] means the list must either have only str or only unicode.
There was a problem hiding this comment.
That makes sense. I'm still wrapping my head around TypeVars, I guess. I keep forgetting that it binds to only one type of string and isn't the same as a Union.
stdlib/2/SimpleHTTPServer.pyi
Outdated
| def do_GET(self) -> None: ... | ||
| def do_HEAD(self) -> None: ... | ||
| def send_head(self) -> Optional[IO[str]]: ... | ||
| def list_directory(self, path: AnyStr) -> Optional[StringIO]: ... |
There was a problem hiding this comment.
This argument should be a Union. listdir takes AnyStr because its return value depends on the type passed in, but that's not true for this function.
There was a problem hiding this comment.
Got it.
Petition to rename AnyStr to ExactlyOneStr?
There was a problem hiding this comment.
I kind of agree. I'm not sure AnyStr should have been added to typing, since it's frequently misunderstood and it's really much more common that you want Union[str, unicode].
There was a problem hiding this comment.
TypeVar(str, unicode) certainly has its uses where you don't want to mix string types together, so it's really just a naming issue. Or it doesn't need to have been a default part of typing, since it's not actually something special.
I'd rather have AnyStr = Union[str, unicode] and EitherStr = TypeVar(str, unicode). Kind of hard to distill "exactly one of str or unicode" into a pithy variable name, unfortunately.
- `list_directory` takes `Union...` instead of `AnyStr` - `translate_path -> AnyStr`
|
Thanks! |
|
Thank you for the extremely helpful reviews! |
No description provided.