o Z&i@sLddlZddlmZddlmZddlmZGdddZGd d d ZdS) N) __version__) get_config) parse_versionc@s:eZdZdZdZdZeddZejddZddZ dS) _HTMLDocumentationLinkMixina3 Mixin class allowing to generate a link to the API documentation. This mixin relies on three attributes: - `_doc_link_module`: it corresponds to the root module (e.g. `sklearn`). Using this mixin, the default value is `sklearn`. - `_doc_link_template`: it corresponds to the template used to generate the link to the API documentation. Using this mixin, the default value is `"https://scikit-learn.org/{version_url}/modules/generated/ {estimator_module}.{estimator_name}.html"`. - `_doc_link_url_param_generator`: it corresponds to a function that generates the parameters to be used in the template when the estimator module and name are not sufficient. The method :meth:`_get_doc_link` generates the link to the API documentation for a given estimator. This useful provides all the necessary states for :func:`sklearn.utils.estimator_html_repr` to generate a link to the API documentation for the estimator HTML diagram. Examples -------- If the default values for `_doc_link_module`, `_doc_link_template` are not suitable, then you can override them and provide a method to generate the URL parameters: >>> from sklearn.base import BaseEstimator >>> doc_link_template = "https://address.local/{single_param}.html" >>> def url_param_generator(estimator): ... return {"single_param": estimator.__class__.__name__} >>> class MyEstimator(BaseEstimator): ... # use "builtins" since it is the associated module when declaring ... # the class in a docstring ... _doc_link_module = "builtins" ... _doc_link_template = doc_link_template ... _doc_link_url_param_generator = url_param_generator >>> estimator = MyEstimator() >>> estimator._get_doc_link() 'https://address.local/MyEstimator.html' If instead of overriding the attributes inside the class definition, you want to override a class instance, you can use `types.MethodType` to bind the method to the instance: >>> import types >>> estimator = BaseEstimator() >>> estimator._doc_link_template = doc_link_template >>> estimator._doc_link_url_param_generator = types.MethodType( ... url_param_generator, estimator) >>> estimator._get_doc_link() 'https://address.local/BaseEstimator.html' ZsklearnNcCs>tt}|jdur|jd|j}nd}t|dd|dS)N.dev__doc_link_templatezhttps://scikit-learn.org/z;/modules/generated/{estimator_module}.{estimator_name}.html)rrr majorminorgetattr)selfZsklearn_versionZ version_urlrHC:\wamp64\www\opt\env\Lib\site-packages\sklearn/utils/_repr_html/base.py_doc_link_templateAs  z._HTMLDocumentationLinkMixin._doc_link_templatecCst|d|dS)Nr )setattr)rvaluerrrrQscCst|jjdd|jkrdS|jdur/|jj}dtdd|jjd}|j j ||dS|j j di|S) aGenerates a link to the API documentation for a given estimator. This method generates the link to the estimator's documentation page by using the template defined by the attribute `_doc_link_template`. Returns ------- url : str The URL to the API documentation for this estimator. If the estimator does not belong to module `_doc_link_module`, the empty string (i.e. `""`) is returned. rrNcSs |d S)N_) startswith)partrrrls z;_HTMLDocumentationLinkMixin._get_doc_link..)estimator_moduleestimator_namer) __class__ __module__split_doc_link_module_doc_link_url_param_generator__name__join itertools takewhilerformat)rrrrrr _get_doc_linkUs   z)_HTMLDocumentationLinkMixin._get_doc_link) r r __qualname____doc__rrpropertyrsetterr%rrrrr s2   rc@s,eZdZdZeddZddZddZdS) ReprHTMLMixinzMixin to handle consistently the HTML representation. When inheriting from this class, you need to define an attribute `_html_repr` which is a callable that returns the HTML representation to be shown. cCstddkr td|jS)aHTML representation of estimator. This is redundant with the logic of `_repr_mimebundle_`. The latter should be favored in the long term, `_repr_html_` is only implemented for consumers who do not interpret `_repr_mimbundle_`. displaydiagramzW_repr_html_ is only defined when the 'display' configuration option is set to 'diagram')rAttributeError_repr_html_innerrrrr _repr_html_}s zReprHTMLMixin._repr_html_cCs|S)zThis function is returned by the @property `_repr_html_` to make `hasattr(estimator, "_repr_html_") return `True` or `False` depending on `get_config()["display"]`. ) _html_reprr/rrrr.szReprHTMLMixin._repr_html_innercKs*dt|i}tddkr||d<|S)z8Mime bundle used by jupyter kernels to display estimatorz text/plainr+r,z text/html)reprrr1)rkwargsoutputrrr_repr_mimebundle_s  zReprHTMLMixin._repr_mimebundle_N)r rr&r'r(r0r.r5rrrrr*vs   r*) r"rr_configrfixesrrr*rrrrs    k