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

💬 Missing EBD names in json meta data #246

Open
OLILHR opened this issue Oct 10, 2024 · 8 comments
Open

💬 Missing EBD names in json meta data #246

OLILHR opened this issue Oct 10, 2024 · 8 comments
Assignees

Comments

@OLILHR
Copy link
Member

OLILHR commented Oct 10, 2024

json meta data currently look like this:

"metadata": {
    "chapter": "MaBiS",
    "ebd_code": "E_0009",
    "role": "BIKO",
    "sub_chapter": "7.4.1: AD: Deaktivierung eines MaBiS-ZP für Netzzeitreihe an BIKO"
  },

but EBDs have names that are currently missing across all json files.
For instance E_0009 = E_0009_MaBiS-ZP Deaktivierung prüfen.

@hf-kklein
Copy link
Contributor

Ich glaube was falsch ist, ist das chapter.
zumindest im docstring sieht es nach dem aus, was du suchst:

https://github.com/Hochfrequenz/rebdhuhn/blob/12df2a5bd75f66aa9721c202a9b3cafa19ac22d2/src/rebdhuhn/models/ebd_table.py#L23-L27

@OLILHR
Copy link
Member Author

OLILHR commented Oct 10, 2024

Ich glaube was falsch ist, ist das chapter. zumindest im docstring sieht es nach dem aus, was du suchst:

https://github.com/Hochfrequenz/rebdhuhn/blob/12df2a5bd75f66aa9721c202a9b3cafa19ac22d2/src/rebdhuhn/models/ebd_table.py#L23-L27

eher das sub-chapter, oder? das chapter scheint oben in den Metadaten zu fehlen; und was in meinem Beispiel oben das sub-chapter ist, ist eigentlich das chapter. In deinem Link siehts so aus, als ist sub-chaper = EBD name.

@hf-kklein
Copy link
Contributor

Der Name klingt so als würden wir es aus irgendwelchen Headings Inder word ziehen. Vllt ist es nur Bold und kein heading?

@DeltaDaniel
Copy link
Contributor

Es gibt noch einen subsection_title in dem entsprechenden Modell der EBD_amame

@attrs.define(kw_only=True, frozen=True)
class EbdChapterInformation:
"""
Contains information about where an EBD is located within the document.
If the heading is e.g. "5.2.1" we denote this as:
* chapter 5
* section 2
* subsection 1
"""
chapter: int = attrs.field(
validator=attrs.validators.and_(attrs.validators.instance_of(int), attrs.validators.ge(1))
)
chapter_title: Optional[str] = attrs.field(validator=attrs.validators.optional(attrs.validators.instance_of(str)))
section: int = attrs.field(
validator=attrs.validators.and_(attrs.validators.instance_of(int), attrs.validators.ge(1))
)
section_title: Optional[str] = attrs.field(validator=attrs.validators.optional(attrs.validators.instance_of(str)))
subsection: int = attrs.field(
validator=attrs.validators.and_(attrs.validators.instance_of(int), attrs.validators.ge(1))
)
subsection_title: Optional[str] = attrs.field(
validator=attrs.validators.optional(attrs.validators.instance_of(str))
)

@DeltaDaniel
Copy link
Contributor

Ist eher ein Thema für das R_EBD_Huhn.

"metadata": {
    "chapter": "MaBiS",
    "ebd_code": "E_0009",
    "role": "BIKO",
    "sub_chapter": "7.4.1: AD: Deaktivierung eines MaBiS-ZP für Netzzeitreihe an BIKO"
  },

Hier fehlt eine Ebene. Also irgendwas wie:

"metadata": {
  "chapter": "MaBiS",
  "ebd_code": "E_0009",
  "role": "BIKO",
  "sub_chapter": "7.4.: AD: Deaktivierung eines MaBiS-ZP für Netzzeitreihe an BIKO",
  "sub_sub_chapter": "7.4.1: E_0009_MaBiS-ZP Deaktivierung prüfen"
},

Mein Vorschlag:

"metadata": {
 "chapter": "7.4.: AD: Deaktivierung eines MaBiS-ZP für Netzzeitreihe an BIKO",
 "ebd_code": "E_0009",
 "role": "BIKO",
 "sub_chapter":  "7.4.1: E_0009_MaBiS-ZP Deaktivierung prüfen"
},

@hf-kklein, @OLILHR: Was meint ihr?

@hf-kklein
Copy link
Contributor

hf-kklein commented Oct 28, 2024

das alte leidige thema :D

wo definieren wir unsere models?

klar, pass es gerne in r_ebd_huhn an, aber am besten optional und per default none, so dass bestehendes zeug nicht bricht.

@OLILHR
Copy link
Member Author

OLILHR commented Nov 4, 2024

Stand 04.11.24

{
    "metadata": {
        "chapter": "z.B. MaBiS",
        "ebd_code": "z.B. E_0001",
        "role": "z.B. LF",
        "section": "x.x.x: AD: Lieferbeginn", (war mal "sub_chapter")
        "ebd_name": "z.B. Prüfen, ob ..." (neu)
        "remark": "Derzeit ist für diese Entscheidung kein Entscheidungsbaum notwendig, da keine Antwort gegeben wird." (neu, betrifft nur EBDs ohne Tabellen)
    },
    ...
}

wenn sub_chapter -> section refactoring zu viele Probleme verursacht, bleibt sub_chapter

@OLILHR
Copy link
Member Author

OLILHR commented Nov 5, 2024

#286

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

When branches are created from issues, their pull requests are automatically linked.

3 participants