Fund: feature: Support `__new__` signatures for classses

feature: Support __new__ signatures for classses

#320

@Viicos

4 months ago

👍

Is your feature request related to a problem? Please describe.

The Class.parameters property uses __init__ by default:

griffe/src/_griffe/models.py

Lines 1605 to 1615 in 58eb9f4

    
               def parameters(self) -> Parameters: 
        
                   """The parameters of this class' `__init__` method, if any. 
        
                   This property fetches inherited members, 
        
                   and therefore is part of the consumer API: 
        
                   do not use when producing Griffe trees! 
        
                   """ 
        
                   try: 
        
                       return self.all_members["__init__"].parameters  # type: ignore[union-attr] 
        
                   except KeyError: 
        
                       return Parameters()

It would be nice if __new__ could be supported as well. Behavior when both are defined should probably be considered. The typing specification regarding constructors might help in defining a strategy.

Timothée Mazzucotelli/griffe

feature: Support new signatures for classses

Is your feature request related to a problem? Please describe.

Describe the solution you'd like

Describe alternatives you've considered

Additional context

How does funding with Polar work?

Backer

Contributor

Maintainer

	def parameters(self) -> Parameters:
	"""The parameters of this class' `__init__` method, if any.

	This property fetches inherited members,
	and therefore is part of the consumer API:
	do not use when producing Griffe trees!
	"""
	try:
	return self.all_members["__init__"].parameters # type: ignore[union-attr]
	except KeyError:
	return Parameters()

Timothée Mazzucotelli/griffe

feature: Support __new__ signatures for classses

Is your feature request related to a problem? Please describe.

Describe the solution you'd like

Describe alternatives you've considered

Additional context

How does funding with Polar work?

Backer

Why does "Fund on completion" require GitHub login?

When is the invoice due for "Fund on completion"?

What happens if the issue is never completed?

Do I get any extra benefits by funding?

Do I get progress updates?

Contributor

Do I get a reward?

Is rewards guaranteed?

Maintainer

How can I get funding like this for my open source initiatives?

feature: Support new signatures for classses