Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

♻️ Change needs_global_options format #1413

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

chrisjsewell
Copy link
Member

@chrisjsewell chrisjsewell commented Feb 27, 2025

In the current format each key value can be in multiple different formats, which makes it difficult to understand, parse, validate, and provide a JSON schema for in ubproject.toml

In this PR we deprecate the old format (it can still be used for now but will emit a warning with the new format),
and replace it with a slightly more verbose, but consistent format:

old:

needs_global_options = {
    "field1": "a",
    "field2": ("a", 'status == "done"'),
    "field3": ("a", 'status == "done"', "b"),
    "field4": [
        ("a", 'status == "done"'),
        ("b", 'status == "ongoing"'),
        ("c", 'status == "other"', "d"),
    ],
}

new:

needs_global_options = {
    "field1": {"default": "a"},
    "field2": {"predicates": [('status == "done"', "a")]},
    "field3": {
        "predicates": [('status == "done"', "a")],
        "default": "b",
    },
    "field4": {
        "predicates": [
            ('status == "done"', "a"),
            ('status == "ongoing"', "b"),
            ('status == "other"', "c"),
        ],
        "default": "d",
    },
}

new, in ubproject.toml format:

[needs.global_options]
field1.default = "a"
field2.predicates = [['status == "done"', "a"]]
field3.predicates = [['status == "done"', "a"]]
field3.default = "b"
field4.predicates = [
    ['status == "done"', "a"],
    ['status == "ongoing"', "b"],
    ['status == "other"', "c"]
]
field4.default = "d"

and this is the auto-generated JSON schema from ubcode:

{
  "properties": {
        "global_options": {
          "additionalProperties": {
            "$ref": "#/definitions/GlobalOptionValue"
          },
          "default": {},
          "description": "Default values given to specified fields of needs",
          "type": "object"
        }
  },
  "definitions": {
    "GlobalOptionValue": {
      "properties": {
        "default": {
          "default": null,
          "description": "This value is used, if the field has not been specifically set, and no predicate matches."
        },
        "predicates": {
          "default": [],
          "description": "A list of (filter predicate, value) to match against the need. If the field has not been specifically set, the value of the first predicate that matches is used.",
          "items": {
            "items": [
              {
                "type": "string"
              },
              true
            ],
            "maxItems": 2,
            "minItems": 2,
            "type": "array"
          },
          "type": "array"
        }
      },
      "type": "object"
    }
  }
}

TODO update documentation

In the current format each value can be in multiple different formats, which makes it difficult to understand, parse, and provide a json schema for in `ubproject.toml`

In this PR we deprecate the old format (it can still be used for now but will emit a warning), and replace it with a more consistent format:

old:

```python
needs_global_options = {
    "field1": "a",
    "field2": ("a", 'status == "done"'),
    "field3": ("a", 'status == "done"', "b"),
    "field4": [
        ("a", 'status == "done"'),
        ("b", 'status == "ongoing"'),
        ("c", 'status == "other"', "d"),
    ],
}
```

new:

```python
needs_global_options = {
    "field1": {"default": "a"},
    "field2": {"predicates": [('status == "done"', "a")]},
    "field3": {
        "predicates": [('status == "done"', "a")],
        "default": "b",
    },
    "field4": {
        "predicates": [
            ('status == "done"', "a"),
            ('status == "ongoing"', "b"),
            ('status == "other"', "c"),
        ],
        "default": "d",
    },
}
```

new in `ubproject.toml` format:

```toml
[needs.global_options]
field1.default = "a"
field2.predicates = [['status == "done"', "a"]]
field3.predicates = [['status == "done"', "a"]]
field3.default = "b"
field4.predicates = [
    ['status == "done"', "a"],
    ['status == "ongoing"', "b"],
    ['status == "other"', "c"]
]
field4.default = "d"
```

TODO update documentation
Copy link

codecov bot commented Feb 27, 2025

Codecov Report

Attention: Patch coverage is 95.65217% with 1 line in your changes missing coverage. Please review.

Project coverage is 88.54%. Comparing base (4e10030) to head (efc6353).
Report is 117 commits behind head on master.

Files with missing lines Patch % Lines
sphinx_needs/needs.py 95.23% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1413      +/-   ##
==========================================
+ Coverage   86.87%   88.54%   +1.66%     
==========================================
  Files          56       60       +4     
  Lines        6532     7231     +699     
==========================================
+ Hits         5675     6403     +728     
+ Misses        857      828      -29     
Flag Coverage Δ
pytests 88.54% <95.65%> (+1.66%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant