class_docstr: Geocoder using the IGN France GeoCoder OpenLS API.
  
  Documentation at:
      https://geoservices.ign.fr/services-web-essentiels
class_docstr_tok: ["Geocoder","using","the","IGN","France","GeoCoder","OpenLS","API",".","Documentation","at",":","https",":","\/\/geoservices.ign.fr\/services-web-essentiels"]
docstr: :param str api_key: Not used.
  
      .. deprecated:: 2.3
          IGNFrance geocoding methods no longer accept or require
          authentication, see `<https://geoservices.ign.fr/actualites/2021-10-04-evolution-des-modalites-dacces-aux-services-web>`_.
          This parameter is scheduled for removal in geopy 3.0.
  
  :param str username: Not used.
  
      .. deprecated:: 2.3
          See the `api_key` deprecation note.
  
  :param str password: Not used.
  
      .. deprecated:: 2.3
          See the `api_key` deprecation note.
  
  :param str referer: Not used.
  
      .. deprecated:: 2.3
          See the `api_key` deprecation note.
  
  :param str domain: Currently it is ``'wxs.ign.fr'``, can
      be changed for testing purposes for developer API
      e.g ``'gpp3-wxs.ign.fr'`` at the moment.
  
  :param str scheme:
      See :attr:`geopy.geocoders.options.default_scheme`.
  
  :param int timeout:
      See :attr:`geopy.geocoders.options.default_timeout`.
  
  :param dict proxies:
      See :attr:`geopy.geocoders.options.default_proxies`.
  
  :param str user_agent:
      See :attr:`geopy.geocoders.options.default_user_agent`.
  
  :type ssl_context: :class:`ssl.SSLContext`
  :param ssl_context:
      See :attr:`geopy.geocoders.options.default_ssl_context`.
  
  :param callable adapter_factory:
      See :attr:`geopy.geocoders.options.default_adapter_factory`.
  
      .. versionadded:: 2.0
docstr_tok: [":","param","str","api_key",":","Not","used",".","..","deprecated",":",":","2.3","IGNFrance","geocoding","methods","no","longer","accept","or","require","authentication",",","see","`","<","https",":","\/\/geoservices.ign.fr\/actualites\/2021-10-04-evolution-des-modalites-dacces-aux-services-web",">","`","_",".","This","parameter","is","scheduled","for","removal","in","geopy","3.0.",":","param","str","username",":","Not","used",".","..","deprecated",":",":","2.3","See","the","`","api_key","`","deprecation","note",".",":","param","str","password",":","Not","used",".","..","deprecated",":",":","2.3","See","the","`","api_key","`","deprecation","note",".",":","param","str","referer",":","Not","used",".","..","deprecated",":",":","2.3","See","the","`","api_key","`","deprecation","note",".",":","param","str","domain",":","Currently","it","is","``","'wxs.ign.fr","'","``",",","can","be","changed","for","testing","purposes","for","developer","API","e.g","``","'gpp3-wxs.ign.fr","'","``","at","the","moment",".",":","param","str","scheme",":","See",":","attr",":","`","geopy.geocoders.options.default_scheme","`",".",":","param","int","timeout",":","See",":","attr",":","`","geopy.geocoders.options.default_timeout","`",".",":","param","dict","proxies",":","See",":","attr",":","`","geopy.geocoders.options.default_proxies","`",".",":","param","str","user_agent",":","See",":","attr",":","`","geopy.geocoders.options.default_user_agent","`",".",":","type","ssl_context",":",":","class",":","`","ssl.SSLContext","`",":","param","ssl_context",":","See",":","attr",":","`","geopy.geocoders.options.default_ssl_context","`",".",":","param","callable","adapter_factory",":","See",":","attr",":","`","geopy.geocoders.options.default_adapter_factory","`",".","..","versionadded",":",":","2.0"]
code: def __init__(
      self,
      api_key=None,
      *,
      username=None,
      password=None,
      referer=None,
      domain="wxs.ign.fr",
      scheme=None,
      timeout=DEFAULT_SENTINEL,
      proxies=DEFAULT_SENTINEL,
      user_agent=None,
      ssl_context=DEFAULT_SENTINEL,
      adapter_factory=None,
  ):
      """
  
      :param str api_key: Not used.
  
          .. deprecated:: 2.3
              IGNFrance geocoding methods no longer accept or require
              authentication, see `<https://geoservices.ign.fr/actualites/2021-10-04-evolution-des-modalites-dacces-aux-services-web>`_.
              This parameter is scheduled for removal in geopy 3.0.
  
      :param str username: Not used.
  
          .. deprecated:: 2.3
              See the `api_key` deprecation note.
  
      :param str password: Not used.
  
          .. deprecated:: 2.3
              See the `api_key` deprecation note.
  
      :param str referer: Not used.
  
          .. deprecated:: 2.3
              See the `api_key` deprecation note.
  
      :param str domain: Currently it is ``'wxs.ign.fr'``, can
          be changed for testing purposes for developer API
          e.g ``'gpp3-wxs.ign.fr'`` at the moment.
  
      :param str scheme:
          See :attr:`geopy.geocoders.options.default_scheme`.
  
      :param int timeout:
          See :attr:`geopy.geocoders.options.default_timeout`.
  
      :param dict proxies:
          See :attr:`geopy.geocoders.options.default_proxies`.
  
      :param str user_agent:
          See :attr:`geopy.geocoders.options.default_user_agent`.
  
      :type ssl_context: :class:`ssl.SSLContext`
      :param ssl_context:
          See :attr:`geopy.geocoders.options.default_ssl_context`.
  
      :param callable adapter_factory:
          See :attr:`geopy.geocoders.options.default_adapter_factory`.
  
          .. versionadded:: 2.0
      """  # noqa
      super().__init__(
          scheme=scheme,
          timeout=timeout,
          proxies=proxies,
          user_agent=user_agent,
          ssl_context=ssl_context,
          adapter_factory=adapter_factory,
      )
  
      if api_key or username or password or referer:
          warnings.warn(
              "IGNFrance no longer accepts or requires authentication, "
              "so api_key, username, password and referer are not used "
              "anymore. These arguments should be removed. "
              "In geopy 3 these options will be removed, causing "
              "an error instead of this warning.",
              DeprecationWarning,
              stacklevel=2,
          )
  
      self.domain = domain.strip("/")
      api_path = self.api_path
      self.api = "%s://%s%s" % (self.scheme, self.domain, api_path)
  
file_path: geopy/geopy/geocoders/ignfrance.py
imports: import warnings
  import xml.etree.ElementTree
  from functools import partial
  from urllib.parse import urlencode
  from geopy.exc import GeocoderQueryError
  from geopy.geocoders.base import DEFAULT_SENTINEL, Geocoder
  from geopy.location import Location
  from geopy.util import logger
label_desc: Use image node_id 1 to create a new IGNFrance object from inherited base classes: Geocoder with example: obj = IGNFrance(api_key)