NotificationsYou must be signed in to change notification settings
Fork7.9k
Star21.4k

Commita4a0925

committed

Deprecate rcParams["datapath"] in favor of mpl.get_data_path().

The rcParam cannot be meaningfully set by the end user from theirmatplotlibrc or Python code.

1 parentc0fca72 commita4a0925Copy full SHA for a4a0925

File tree

5 files changed

+17

-16

lines changed

doc/api
- matplotlib_configuration_api.rst
- next_api_changes
  - deprecations.rst
lib/matplotlib
- __init__.py
- cbook
  - __init__.py
matplotlibrc.template

5 files changed

+17

-16

lines changed

`‎doc/api/matplotlib_configuration_api.rst`

Lines changed: 2 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -45,6 +45,8 @@ Default values and styling`
`45`	`45`
`46`	`46`	`..autofunction::matplotlib_fname`
`47`	`47`
	`48`	`+..autofunction::get_data_path`
	`49`	`+`
`48`	`50`	`Logging`
`49`	`51`	`=======`
`50`	`52`

`‎doc/api/next_api_changes/deprecations.rst`

Lines changed: 5 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -282,3 +282,8 @@ is deprecated, set the offset to 0 instead.`
`282`	`282`	``RendererCairo.fontweights``, ``RendererCairo.fontangles``
`283`	`283`	`~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~`
`284`	`284`	`... are deprecated.`
	`285`	`+`
	`286`	+The ``datapath`` rcParam
	`287`	`+~~~~~~~~~~~~~~~~~~~~~~~~`
	`288`	+Use `.get_data_path` instead. (The rcParam is deprecated because it cannot be
	`289`	`+meaningfully set by an end user.) This was deprecated only in 3.2.1.`

`‎lib/matplotlib/init.py`

Lines changed: 9 additions & 11 deletions

Original file line number	Diff line number	Diff line change
`@@ -507,11 +507,13 @@ def get_cachedir():`
`507`	`507`	`return_get_config_or_cache_dir(_get_xdg_cache_dir())`
`508`	`508`
`509`	`509`
`510`		`-def_get_data_path():`
`511`		`-"""Return the path to matplotlib data."""`
	`510`	`+@_logged_cached('matplotlib data path: %s')`
	`511`	`+defget_data_path():`
	`512`	`+"""Return the path to Matplotlib data."""`
`512`	`513`
`513`	`514`	`path=Path(__file__).with_name("mpl-data")`
`514`	`515`	`ifpath.is_dir():`
	`516`	`+defaultParams['datapath'][0]=str(path)`
`515`	`517`	`returnstr(path)`
`516`	`518`
`517`	`519`	`cbook.warn_deprecated(`
`@@ -534,18 +536,12 @@ def get_candidate_paths():`
`534`	`536`
`535`	`537`	`forpathinget_candidate_paths():`
`536`	`538`	`ifpath.is_dir():`
	`539`	`+defaultParams['datapath'][0]=str(path)`
`537`	`540`	`returnstr(path)`
`538`	`541`
`539`	`542`	`raiseRuntimeError('Could not find the matplotlib data files')`
`540`	`543`
`541`	`544`
`542`		`-@_logged_cached('matplotlib data path: %s')`
`543`		`-defget_data_path():`
`544`		`-ifdefaultParams['datapath'][0]isNone:`
`545`		`-defaultParams['datapath'][0]=_get_data_path()`
`546`		`-returndefaultParams['datapath'][0]`
`547`		`-`
`548`		`-`
`549`	`545`	`defmatplotlib_fname():`
`550`	`546`	`"""`
`551`	`547`	`Get the location of the config file.`
`@@ -600,6 +596,7 @@ def gen_candidates():`
`600`	`596`	`# listed in the rcParams (not included in _all_deprecated).`
`601`	`597`	`# Values are tuples of (version,)`
`602`	`598`	`_deprecated_remain_as_none= {`
	`599`	`+'datapath': ('3.2.1',),`
`603`	`600`	`'animation.avconv_path': ('3.3',),`
`604`	`601`	`'animation.avconv_args': ('3.3',),`
`605`	`602`	`'mathtext.fallback_to_cm': ('3.3',),`
`@@ -841,8 +838,9 @@ def rc_params_from_file(fname, fail_on_error=False, use_default_template=True):`
`841`	`838`	`ifkeynotin_all_deprecated])`
`842`	`839`	`config.update(config_from_file)`
`843`	`840`
`844`		`-ifconfig['datapath']isNone:`
`845`		`-config['datapath']=get_data_path()`
	`841`	`+withcbook._suppress_matplotlib_deprecation_warning():`
	`842`	`+ifconfig['datapath']isNone:`
	`843`	`+config['datapath']=get_data_path()`
`846`	`844`
`847`	`845`	`if"".join(config['text.latex.preamble']):`
`848`	`846`	`_log.info("""`

`‎lib/matplotlib/cbook/init.py`

Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -474,7 +474,7 @@ def get_sample_data(fname, asfileobj=True):`
`474`	`474`
`475`	`475`	`If the filename ends in .gz, the file is implicitly ungzipped.`
`476`	`476`	`"""`
`477`		`-path=Path(matplotlib._get_data_path(),'sample_data',fname)`
	`477`	`+path=Path(matplotlib.get_data_path(),'sample_data',fname)`
`478`	`478`	`ifasfileobj:`
`479`	`479`	`suffix=path.suffix.lower()`
`480`	`480`	`ifsuffix=='.gz':`

`‎matplotlibrc.template`

Lines changed: 0 additions & 4 deletions

Original file line number	Diff line number	Diff line change
`@@ -95,10 +95,6 @@`
`95`	`95`	`#toolbar: toolbar2 # {None, toolbar2}`
`96`	`96`	`#timezone: UTC # a pytz timezone string, e.g., US/Central or Europe/Paris`
`97`	`97`
`98`		`-## Where your matplotlib data lives if you installed to a non-default`
`99`		`-## location. This is where the matplotlib fonts, bitmaps, etc reside`
`100`		`-#datapath: /home/jdhunter/mpldata`
`101`		`-`
`102`	`98`
`103`	`99`	`## ***************************************************************************`
`104`	`100`	`## * LINES *`

0 commit comments

Comments

(0)

Movatterモバイル変換

Navigation Menu

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Commita4a0925

File tree

5 files changed

5 files changed

`‎doc/api/matplotlib_configuration_api.rst`

`‎doc/api/next_api_changes/deprecations.rst`

`‎lib/matplotlib/init.py`

`‎lib/matplotlib/cbook/init.py`

`‎matplotlibrc.template`

0 commit comments

Movatterモバイル変換

Uh oh!

File tree

5 files changed

5 files changed

‎doc/api/matplotlib_configuration_api.rst

‎doc/api/next_api_changes/deprecations.rst

‎lib/matplotlib/__init__.py

‎lib/matplotlib/cbook/__init__.py

‎matplotlibrc.template

0 commit comments

`‎doc/api/matplotlib_configuration_api.rst`

`‎doc/api/next_api_changes/deprecations.rst`

`‎lib/matplotlib/init.py`

`‎lib/matplotlib/cbook/init.py`

`‎matplotlibrc.template`