add get_[relative_airmass,sky_diffuse,ground_diffuse,extra_radiation,total_irradiance] and pvlibDeprecationWarning #427
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,318 @@ | ||
| """Matplotlib license for the deprecation module. | ||
|
|
||
| License agreement for matplotlib versions 1.3.0 and later | ||
| ========================================================= | ||
|
|
||
| 1. This LICENSE AGREEMENT is between the Matplotlib Development Team | ||
| ("MDT"), and the Individual or Organization ("Licensee") accessing and | ||
| otherwise using matplotlib software in source or binary form and its | ||
| associated documentation. | ||
|
|
||
| 2. Subject to the terms and conditions of this License Agreement, MDT | ||
| hereby grants Licensee a nonexclusive, royalty-free, world-wide license | ||
| to reproduce, analyze, test, perform and/or display publicly, prepare | ||
| derivative works, distribute, and otherwise use matplotlib | ||
| alone or in any derivative version, provided, however, that MDT's | ||
| License Agreement and MDT's notice of copyright, i.e., "Copyright (c) | ||
| 2012- Matplotlib Development Team; All Rights Reserved" are retained in | ||
| matplotlib alone or in any derivative version prepared by | ||
| Licensee. | ||
|
|
||
| 3. In the event Licensee prepares a derivative work that is based on or | ||
| incorporates matplotlib or any part thereof, and wants to | ||
| make the derivative work available to others as provided herein, then | ||
| Licensee hereby agrees to include in any such work a brief summary of | ||
| the changes made to matplotlib . | ||
|
|
||
| 4. MDT is making matplotlib available to Licensee on an "AS | ||
| IS" basis. MDT MAKES NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR | ||
| IMPLIED. BY WAY OF EXAMPLE, BUT NOT LIMITATION, MDT MAKES NO AND | ||
| DISCLAIMS ANY REPRESENTATION OR WARRANTY OF MERCHANTABILITY OR FITNESS | ||
| FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF MATPLOTLIB | ||
| WILL NOT INFRINGE ANY THIRD PARTY RIGHTS. | ||
|
|
||
| 5. MDT SHALL NOT BE LIABLE TO LICENSEE OR ANY OTHER USERS OF MATPLOTLIB | ||
| FOR ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES OR | ||
| LOSS AS A RESULT OF MODIFYING, DISTRIBUTING, OR OTHERWISE USING | ||
| MATPLOTLIB , OR ANY DERIVATIVE THEREOF, EVEN IF ADVISED OF | ||
| THE POSSIBILITY THEREOF. | ||
|
|
||
| 6. This License Agreement will automatically terminate upon a material | ||
| breach of its terms and conditions. | ||
|
|
||
| 7. Nothing in this License Agreement shall be deemed to create any | ||
| relationship of agency, partnership, or joint venture between MDT and | ||
| Licensee. This License Agreement does not grant permission to use MDT | ||
| trademarks or trade name in a trademark sense to endorse or promote | ||
| products or services of Licensee, or any third party. | ||
|
|
||
| 8. By copying, installing or otherwise using matplotlib , | ||
| Licensee agrees to be bound by the terms and conditions of this License | ||
| Agreement. | ||
|
|
||
| License agreement for matplotlib versions prior to 1.3.0 | ||
| ======================================================== | ||
|
|
||
| 1. This LICENSE AGREEMENT is between John D. Hunter ("JDH"), and the | ||
| Individual or Organization ("Licensee") accessing and otherwise using | ||
| matplotlib software in source or binary form and its associated | ||
| documentation. | ||
|
|
||
| 2. Subject to the terms and conditions of this License Agreement, JDH | ||
| hereby grants Licensee a nonexclusive, royalty-free, world-wide license | ||
| to reproduce, analyze, test, perform and/or display publicly, prepare | ||
| derivative works, distribute, and otherwise use matplotlib | ||
| alone or in any derivative version, provided, however, that JDH's | ||
| License Agreement and JDH's notice of copyright, i.e., "Copyright (c) | ||
| 2002-2011 John D. Hunter; All Rights Reserved" are retained in | ||
| matplotlib alone or in any derivative version prepared by | ||
| Licensee. | ||
|
|
||
| 3. In the event Licensee prepares a derivative work that is based on or | ||
| incorporates matplotlib or any part thereof, and wants to | ||
| make the derivative work available to others as provided herein, then | ||
| Licensee hereby agrees to include in any such work a brief summary of | ||
| the changes made to matplotlib. | ||
|
|
||
| 4. JDH is making matplotlib available to Licensee on an "AS | ||
| IS" basis. JDH MAKES NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR | ||
| IMPLIED. BY WAY OF EXAMPLE, BUT NOT LIMITATION, JDH MAKES NO AND | ||
| DISCLAIMS ANY REPRESENTATION OR WARRANTY OF MERCHANTABILITY OR FITNESS | ||
| FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF MATPLOTLIB | ||
| WILL NOT INFRINGE ANY THIRD PARTY RIGHTS. | ||
|
|
||
| 5. JDH SHALL NOT BE LIABLE TO LICENSEE OR ANY OTHER USERS OF MATPLOTLIB | ||
| FOR ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES OR | ||
| LOSS AS A RESULT OF MODIFYING, DISTRIBUTING, OR OTHERWISE USING | ||
| MATPLOTLIB , OR ANY DERIVATIVE THEREOF, EVEN IF ADVISED OF | ||
| THE POSSIBILITY THEREOF. | ||
|
|
||
| 6. This License Agreement will automatically terminate upon a material | ||
| breach of its terms and conditions. | ||
|
|
||
| 7. Nothing in this License Agreement shall be deemed to create any | ||
| relationship of agency, partnership, or joint venture between JDH and | ||
| Licensee. This License Agreement does not grant permission to use JDH | ||
| trademarks or trade name in a trademark sense to endorse or promote | ||
| products or services of Licensee, or any third party. | ||
|
|
||
| 8. By copying, installing or otherwise using matplotlib, | ||
| Licensee agrees to be bound by the terms and conditions of this License | ||
| Agreement. | ||
| """ | ||
|
|
||
| # modified from Matplotlib b97cd2d (post 2.2.2) in the following ways: | ||
| # 1. use module-level _projectName = 'pvlib' and | ||
| # _projectWarning = 'pvlibDeprecationWarning' in place of MPL specific | ||
| # string/Class. | ||
| # 2. remove keyword only argument requirement for removal | ||
| # 3. remove deprecated obj_type from deprecated function | ||
| # 4. if removal is empty, say 'soon' instead of assuming two minor releases | ||
| # later. | ||
|
|
||
| import functools | ||
| import textwrap | ||
| import warnings | ||
|
|
||
|
|
||
| class pvlibDeprecationWarning(UserWarning): | ||
| """A class for issuing deprecation warnings for pvlib users. | ||
|
|
||
| In light of the fact that Python builtin DeprecationWarnings are ignored | ||
| by default as of Python 2.7 (see link below), this class was put in to | ||
| allow for the signaling of deprecation, but via UserWarnings which are not | ||
| ignored by default. | ||
|
|
||
| https://docs.python.org/dev/whatsnew/2.7.html#the-future-for-python-2-x | ||
| """ | ||
|
|
||
| pass | ||
|
|
||
|
|
||
| # make it easier for others to copy paste this code into their projects | ||
| _projectName = 'pvlib' | ||
| _projectWarning = pvlibDeprecationWarning | ||
|
|
||
|
|
||
| def _generate_deprecation_message( | ||
| since, message='', name='', alternative='', pending=False, | ||
| obj_type='attribute', addendum='', removal=''): | ||
|
|
||
| if removal == "": | ||
| removal = "soon" | ||
| elif removal: | ||
| if pending: | ||
| raise ValueError( | ||
| "A pending deprecation cannot have a scheduled removal") | ||
| removal = "in {}".format(removal) | ||
|
|
||
| if not message: | ||
| message = ( | ||
| "The %(name)s %(obj_type)s" | ||
| + (" will be deprecated in a future version" | ||
| if pending else | ||
| (" was deprecated in %(projectName)s %(since)s" | ||
| + (" and will be removed %(removal)s" | ||
| if removal else | ||
| ""))) | ||
| + "." | ||
| + (" Use %(alternative)s instead." if alternative else "") | ||
| + (" %(addendum)s" if addendum else "")) | ||
|
|
||
| return message % dict( | ||
| func=name, name=name, obj_type=obj_type, since=since, removal=removal, | ||
| alternative=alternative, addendum=addendum, projectName=_projectName) | ||
|
|
||
|
|
||
| def warn_deprecated( | ||
| since, message='', name='', alternative='', pending=False, | ||
| obj_type='attribute', addendum='', removal=''): | ||
| """ | ||
| Used to display deprecation in a standard way. | ||
| Parameters | ||
| ---------- | ||
| since : str | ||
| The release at which this API became deprecated. | ||
| message : str, optional | ||
| Override the default deprecation message. The format | ||
| specifier `%(name)s` may be used for the name of the function, | ||
| and `%(alternative)s` may be used in the deprecation message | ||
| to insert the name of an alternative to the deprecated | ||
| function. `%(obj_type)s` may be used to insert a friendly name | ||
| for the type of object being deprecated. | ||
| name : str, optional | ||
| The name of the deprecated object. | ||
| alternative : str, optional | ||
| An alternative API that the user may use in place of the deprecated | ||
| API. The deprecation warning will tell the user about this alternative | ||
| if provided. | ||
| pending : bool, optional | ||
| If True, uses a PendingDeprecationWarning instead of a | ||
| DeprecationWarning. Cannot be used together with *removal*. | ||
| removal : str, optional | ||
| The expected removal version. With the default (an empty string), a | ||
| removal version is automatically computed from *since*. Set to other | ||
| Falsy values to not schedule a removal date. Cannot be used together | ||
| with *pending*. | ||
| obj_type : str, optional | ||
| The object type being deprecated. | ||
| addendum : str, optional | ||
| Additional text appended directly to the final message. | ||
| Examples | ||
| -------- | ||
| Basic example:: | ||
| # To warn of the deprecation of "matplotlib.name_of_module" | ||
| warn_deprecated('1.4.0', name='matplotlib.name_of_module', | ||
| obj_type='module') | ||
| """ | ||
| message = '\n' + _generate_deprecation_message( | ||
| since, message, name, alternative, pending, obj_type, addendum, | ||
| removal=removal) | ||
| category = (PendingDeprecationWarning if pending | ||
| else _projectWarning) | ||
| warnings.warn(message, category, stacklevel=2) | ||
|
|
||
|
|
||
| def deprecated(since, message='', name='', alternative='', pending=False, | ||
| addendum='', removal=''): | ||
| """ | ||
| Decorator to mark a function or a class as deprecated. | ||
| Parameters | ||
| ---------- | ||
| since : str | ||
| The release at which this API became deprecated. This is | ||
| required. | ||
| message : str, optional | ||
| Override the default deprecation message. The format | ||
| specifier `%(name)s` may be used for the name of the object, | ||
| and `%(alternative)s` may be used in the deprecation message | ||
| to insert the name of an alternative to the deprecated | ||
| object. | ||
| name : str, optional | ||
| The name of the deprecated object; if not provided the name | ||
| is automatically determined from the passed in object, | ||
| though this is useful in the case of renamed functions, where | ||
| the new function is just assigned to the name of the | ||
| deprecated function. For example:: | ||
| def new_function(): | ||
| ... | ||
| oldFunction = new_function | ||
| alternative : str, optional | ||
| An alternative API that the user may use in place of the deprecated | ||
| API. The deprecation warning will tell the user about this alternative | ||
| if provided. | ||
| pending : bool, optional | ||
| If True, uses a PendingDeprecationWarning instead of a | ||
| DeprecationWarning. Cannot be used together with *removal*. | ||
| removal : str, optional | ||
| The expected removal version. With the default (an empty string), a | ||
| removal version is automatically computed from *since*. Set to other | ||
| Falsy values to not schedule a removal date. Cannot be used together | ||
| with *pending*. | ||
| addendum : str, optional | ||
| Additional text appended directly to the final message. | ||
| Examples | ||
| -------- | ||
| Basic example:: | ||
| @deprecated('1.4.0') | ||
| def the_function_to_deprecate(): | ||
| pass | ||
| """ | ||
|
|
||
| def deprecate(obj, message=message, name=name, alternative=alternative, | ||
| pending=pending, addendum=addendum): | ||
|
|
||
| if not name: | ||
| name = obj.__name__ | ||
|
|
||
| if isinstance(obj, type): | ||
| obj_type = "class" | ||
| old_doc = obj.__doc__ | ||
| func = obj.__init__ | ||
|
|
||
| def finalize(wrapper, new_doc): | ||
| obj.__doc__ = new_doc | ||
| obj.__init__ = wrapper | ||
| return obj | ||
| else: | ||
| obj_type = "function" | ||
| if isinstance(obj, classmethod): | ||
| func = obj.__func__ | ||
| old_doc = func.__doc__ | ||
|
|
||
| def finalize(wrapper, new_doc): | ||
| wrapper = functools.wraps(func)(wrapper) | ||
| wrapper.__doc__ = new_doc | ||
| return classmethod(wrapper) | ||
| else: | ||
| func = obj | ||
| old_doc = func.__doc__ | ||
|
|
||
| def finalize(wrapper, new_doc): | ||
| wrapper = functools.wraps(func)(wrapper) | ||
| wrapper.__doc__ = new_doc | ||
| return wrapper | ||
|
|
||
| message = _generate_deprecation_message( | ||
| since, message, name, alternative, pending, obj_type, addendum, | ||
| removal=removal) | ||
| category = (PendingDeprecationWarning if pending | ||
| else _projectWarning) | ||
|
|
||
| def wrapper(*args, **kwargs): | ||
| warnings.warn(message, category, stacklevel=2) | ||
| return func(*args, **kwargs) | ||
|
|
||
| old_doc = textwrap.dedent(old_doc or '').strip('\n') | ||
| message = message.strip() | ||
| new_doc = (('\n.. deprecated:: %(since)s' | ||
| '\n %(message)s\n\n' % | ||
| {'since': since, 'message': message}) + old_doc) | ||
| if not old_doc: | ||
| # This is to prevent a spurious 'unexected unindent' warning from | ||
| # docutils when the original docstring was blank. | ||
| new_doc += r'\ ' | ||
|
|
||
| return finalize(wrapper, new_doc) | ||
|
|
||
| return deprecate |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
At the risk of prolonging the PR unnecessarily, why not
get_absolute_airmasshere?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
pvlib only includes one absolute airmass model so it didn't occur to me to add
get_here. I'm fine with either approach at this point.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I see your point. It may help when someone is trying to find the relevant function, to keep names parallel. There are other models for absolute air mass which we haven't implement.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Changed.