typing.py contains two doctests that are not executed, ever

Feature or enhancement

typing.py contains at least two doctests:

Lines 3377 to 3414 in 81ab0e8

    
           def is_protocol(tp: type, /) -> bool: 
        
               """Return True if the given type is a Protocol. 
        
               Example:: 
        
                   >>> from typing import Protocol, is_protocol 
        
                   >>> class P(Protocol): 
        
                   ...     def a(self) -> str: ... 
        
                   ...     b: int 
        
                   >>> is_protocol(P) 
        
                   True 
        
                   >>> is_protocol(int) 
        
                   False 
        
               """ 
        
               return ( 
        
                   isinstance(tp, type) 
        
                   and getattr(tp, '_is_protocol', False) 
        
                   and tp != Protocol 
        
               ) 
        
           def get_protocol_members(tp: type, /) -> frozenset[str]: 
        
               """Return the set of members defined in a Protocol. 
        
               Example:: 
        
                   >>> from typing import Protocol, get_protocol_members 
        
                   >>> class P(Protocol): 
        
                   ...     def a(self) -> str: ... 
        
                   ...     b: int 
        
                   >>> get_protocol_members(P) 
        
                   frozenset({'a', 'b'}) 
        
               Raise a TypeError for arguments that are not Protocols. 
        
               """ 
        
               if not is_protocol(tp): 
        
                   raise TypeError(f'{tp!r} is not a Protocol') 
        
               return frozenset(tp.__protocol_attrs__)

But, they are not ever executed.

I propose to add a DocTestSuite to test_typing to run these tests.

Note, that this is related but not similar to #111682

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

`typing.py` contains two doctests that are not executed, ever #112155

Feature or enhancement

Linked PRs

Metadata

Assignees

Labels

Projects

Milestone

Relationships

Development

	def is_protocol(tp: type, /) -> bool:
	"""Return True if the given type is a Protocol.

	Example::

	>>> from typing import Protocol, is_protocol
	>>> class P(Protocol):
	... def a(self) -> str: ...
	... b: int
	>>> is_protocol(P)
	True
	>>> is_protocol(int)
	False
	"""
	return (
	isinstance(tp, type)
	and getattr(tp, '_is_protocol', False)
	and tp != Protocol
	)


	def get_protocol_members(tp: type, /) -> frozenset[str]:
	"""Return the set of members defined in a Protocol.

	Example::

	>>> from typing import Protocol, get_protocol_members
	>>> class P(Protocol):
	... def a(self) -> str: ...
	... b: int
	>>> get_protocol_members(P)
	frozenset({'a', 'b'})

	Raise a TypeError for arguments that are not Protocols.
	"""
	if not is_protocol(tp):
	raise TypeError(f'{tp!r} is not a Protocol')
	return frozenset(tp.__protocol_attrs__)

Search code, repositories, users, issues, pull requests...

Uh oh!

typing.py contains two doctests that are not executed, ever #112155

Description

Feature or enhancement

Linked PRs

Metadata

Metadata

Assignees

Labels

Projects

Milestone

Relationships

Development

Issue actions

`typing.py` contains two doctests that are not executed, ever #112155