Configurable metadata filter options in .jupytext don't appear to be in effect

[rsokl]

Hello! I'm trying out the new config options and it doesn't seem like things are adding up for me.

My config file contains the following

default_notebook_metadata_filter = "-all"
default_cell_metadata_filter = "-all"

My ipynb file has the following metadata

{
  "kernelspec": {
    "display_name": "Python [conda env:.conda-week1]",
    "language": "python",
    "name": "conda-env-.conda-week1-py"
  },
  "language_info": {
    "codemirror_mode": {
      "name": "ipython",
      "version": 3
    },
    "file_extension": ".py",
    "mimetype": "text/x-python",
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
    "version": "3.8.3"
  },
  "nbsphinx": {
    "execute": "never"
  }
}

When I run

jupytext --to md WorkingWithMic.ipynb

the resulting markdown file has the metadata

---
jupyter:
  jupytext:
    text_representation:
      extension: .md
      format_name: markdown
      format_version: '1.2'
      jupytext_version: 1.5.0
  kernelspec:
    display_name: Python [conda env:.conda-week1]
    language: python
    name: conda-env-.conda-week1-py
---

I double checked that find_jupytext_configuration_file('.') returned the appropriate file. Is there something off with how I am doing things here? I should expect all of the metadata to be absent from the .md file, correct?

I tried introducing some random characters in the config file, and it does cause the toml reader to crash, so it does appear that my config file is being parsed during the conversion.

My OS is Windows and I am running jupytext 1.5.0

[mwouts]

Hello @rsokl , well... in Jupytext 1.5.0, the configuration file is used by jupytext --sync, but not by jupytext --to.

Looking back, the reason for this debatable implementation it that the --sync mode is closer to how Jupytext works in Jupyter, and configs were first used in Jupyter (I am not saying this is a good reason!).

So we have a couple options... can you tell me what you think of them?

1. we make it clear in the documentation that jupytext --to does not use the config files, and you use jupytext --sync instead
2. we change the implementation, and default_notebook_metadata_filter = "-all" in the config results in notebook_metadata_filter = "-all" in the notebook when you do jupytext --to if there was no previous filter.
3. or, more similar to what we do for default_jupytext_formats... maybe jupytext --to should act according to the default value, but not write it to the text file?

[rsokl]

Hi @mwouts

To me, it seems like option 2 makes the most sense – it seems intuitive to have my .jupytext file control all transformations created by jupytext. Option 3 is a little hard for me to wrap my head around; specifically it is hard to predict whether or not that would create confusing situations for unwitting users.

[mwouts]

Hi @rsokl , sorry it has been a while since you reported this. I have added a test to make sure that the config file is taken into account, and with the development version the test is green. I'll include this in the upcoming release 1.6.0.

[mwouts]

A release candidate is available here:

pip install jupytext==1.6.0rc0