צור קובץ XBRL באמצעות Python

מסמך XBRL הוא אוסף של עובדות המרכיבות יחד דוח עסקי. נוכל ליצור בקלות מסמך מופע XBRL באופן פרוגרמטי ולהוסיף אובייקטים או אלמנטים כגון הפניה לסכימה, הקשר, יחידה, פריטים וכו’. במאמר זה נלמד כיצד ליצור קובץ XBRL באמצעות Python.

הנושאים הבאים יכוסו במאמר זה:

  1. מה זה XBRL
  2. ספריית Python Finance ליצירת קובצי XBRL
  3. צור קובץ XBRL
  4. הוסף הפניה לסכימה ל-XBRL
  5. הוסף הקשר ב-XBRL
  6. צור יחידה ב-XBRL
  7. הוסף עובדה ב-XBRL
  8. הוסף קישורי הערות שוליים ל-XBRL
  9. הוסף התייחסות לתפקיד ב-XBRL
  10. הוסף התייחסות לתפקיד קשת ל-XBRL

מה זה XBRL

XBRL מייצג eXtensible Business Reporting Language, שפת סימון מבוססת XML. הוא משמש לדיווח עסקי סטנדרטי של ביצועים פיננסיים של חברה. הוא מספק דרך לתקשר ולהחליף מידע עסקי בין מערכות עסקיות.

ספריית פייתון פיננסים ליצירת קובצי XBRL

כדי ליצור קובץ XBRL או מסמך מופע, נשתמש ב-Aspose.Finance for Python API. זה מאפשר יצירת מופעי XBRL, ניתוח ואימות של קבצי XBRL או iXBRL.

ה-API מספק את המחלקה XbrlDocument המייצגת מסמך XBRL המכיל מופע XBRL אחד או יותר. מופע XBRL הוא קטע XML, כאשר לאלמנט השורש יש תג XBRL. המחלקה XbrlInstance מספקת שיטות ומאפיינים שונים לעבודה עם מופעי XBRL. השיטה save() של המחלקה XbrlDocument יוצרת ושומרת את קובץ ה-XBRL בדיסק. קרא עוד על מחלקות אחרות לעבודה עם אובייקטי XBRL ב-API reference.

אנא הורד את החבילה או התקן את ה-API מ-PyPI באמצעות פקודת ה-pip הבאה במסוף:

pip install aspose-finance

צור מסמך מופע XBRL ב- Python

אנו יכולים ליצור בקלות מסמך מופע XBRL מאפס על ידי ביצוע השלבים המפורטים להלן:

  1. ראשית, צור מופע של המחלקה XbrlDocument.
  2. לאחר מכן, גש לאוסף המופעים מהאובייקט XbrlDocument אל האובייקט xbrlinstances.
  3. לאחר מכן, הוסף מופע XBRL חדש באמצעות השיטה xbrlinstances.add() .
  4. לבסוף, שמור את קובץ XBRL בשיטת save(string). זה לוקח את נתיב קובץ הפלט כארגומנט.

דוגמת הקוד הבאה מראה כיצד ליצור מופע XBRL באמצעות Python.

# דוגמה זו מדגימה כיצד ליצור מסמך XBRL
from aspose.finance.xbrl import XbrlDocument

# הנתיב לספריית המסמכים.
outputFile = "C:\\Files\\document.xbrl"

# צור מסמך XBRL
xbrlDoc = XbrlDocument()

# קבל איסוף מופעי מסמכים
xbrlInstances = xbrlDoc.xbrl_instances

# הוסף מופע לאוסף
xbrlInstance = xbrlInstances[xbrlInstances.add()]

# שמור את הקובץ
xbrlDoc.save(outputFile)

לאחר שיצרנו את המופע של XBRL, נוכל להוסיף את ההפניה לסכימה, ההקשר, היחידות, הפריטים, קישורי הערות השוליים, הפניות לתפקידים והפניות לתפקידי קשת במופע XBRL החדש שנוצר.

הוסף התייחסות ל-Schema ל-XBRL באמצעות Python

אנו יכולים להוסיף הפניה לסכימה במסמך מופע XBRL על ידי ביצוע השלבים המפורטים להלן:

  1. ראשית, צור מופע של המחלקה XbrlDocument.
  2. לאחר מכן, הכנס את אוסף המופעים של אובייקט XbrlDocument לאובייקט xbrlinstances.
  3. לאחר מכן, הוסף מופע XBRL חדש באמצעות השיטה xbrlinstances.add() .
  4. לאחר מכן, הכנס את אוסף הפניות הסכימה של אובייקט XbrlInstance לאובייקט schemarefs.
  5. לאחר מכן, הוסף הפניה חדשה לסכימה באמצעות שיטת schemarefs.add() עם קובץ סכימת קלט.
  6. לבסוף, שמור את קובץ XBRL בשיטת save(string).

דוגמת הקוד הבאה מראה כיצד ליצור מסמך מופע XBRL ולהוסיף הפניה לסכימה ב-Python.

# דוגמה זו מדגימה כיצד ליצור מסמך XBRL ולהוסיף אובייקט התייחסות לסכימה
from aspose.finance.xbrl import XbrlDocument

# הנתיב לספריית המסמכים.
outputFile = "C:\\Files\\document.xbrl"
inputSchemaFile = "C:\\Files\\schema.xsd"

# צור מסמך XBRL
xbrlDoc = XbrlDocument()

# קבל איסוף מופעי מסמכים
xbrlInstances = xbrlDoc.xbrl_instances

# הוסף מופע לאוסף
xbrlInstance = xbrlInstances[xbrlInstances.add()]

# קבל אוסף הפניות לסכימת מופעים
schemaRefs = xbrlInstance.schema_refs

# הוסף סכימה
schemaRefs.add(inputSchemaFile, "example", "http://example.com/xbrl/taxonomy")

# שמור את המסמך
xbrlDoc.save(outputFile)

הוסף הקשר ב-XBRL באמצעות Python

אנו יכולים להוסיף הקשר למסמך מופע XBRL על ידי ביצוע השלבים המפורטים להלן:

  1. ראשית, צור מופע של המחלקה XbrlDocument.
  2. לאחר מכן, הוסף מופע XBRL חדש ל-xbrlinstances של אובייקט XbrlDocument.
  3. לאחר מכן, צור מופע של המחלקה ContextPeriod עם תאריכי ההתחלה והסיום.
  4. לאחר מכן, צור אובייקט ContextEntity עם סכימה ומזהה.
  5. לאחר מכן, צור מופע של המחלקה Context עם ContextPeriod ו-ContextEntity המוגדרים.
  6. לאחר מכן, הוסף את אובייקט ההקשר לאוסף ההקשרים.
  7. לבסוף, שמור את קובץ XBRL בשיטת save(string).

דוגמת הקוד הבאה מראה כיצד ליצור מסמך מופע XBRL ולהוסיף אובייקט הקשר ב- Python.

# דוגמה זו מדגימה כיצד ליצור מסמך XBRL ולהוסיף אובייקט Context
from datetime import datetime
from aspose.finance.xbrl import XbrlDocument,ContextPeriod,ContextEntity,Context

# הנתיב לספריית המסמכים.
outputFile = "C:\\Files\\document.xbrl"

# צור מסמך XBRL
xbrlDoc = XbrlDocument()

# קבל איסוף מופעי מסמכים
xbrlInstances = xbrlDoc.xbrl_instances

# הוסף מופע לאוסף
xbrlInstance = xbrlInstances[xbrlInstances.add()]

# הוסף תקופת הקשר
contextPeriod = ContextPeriod(datetime(2020,1,1), datetime(2020,2,10))

# הוסף ישות הקשר
contextEntity = ContextEntity("exampleIdentifierScheme", "exampleIdentifier")

# הגדר והוסף הקשר
context = Context(contextPeriod, contextEntity)
xbrlInstance.contexts.append(context)

# שמור את המסמך
xbrlDoc.save(outputFile)

צור יחידות ב-XBRL באמצעות Python

היחידות ב-XBRL מודדות פריטים מספריים. אנו יכולים להוסיף יחידה במסמך מופע XBRL על ידי ביצוע השלבים המפורטים להלן:

  1. ראשית, צור מופע של המחלקה XbrlDocument.
  2. לאחר מכן, הוסף מופע XBRL חדש ל-xbrlinstances של אובייקט XbrlDocument.
  3. לאחר מכן, צור מופע של המחלקה Unit עם ה-UnitType בתור MEASURE.
  4. לאחר מכן, הוסף QualifiedName לאוסף measurequalifiednames.
  5. לאחר מכן, הוסף את היחידה לאוסף היחידות.
  6. לבסוף, שמור את קובץ XBRL בשיטת save(string).

דוגמת הקוד הבאה מראה כיצד ליצור קובץ XBRL ולהוסיף אובייקט יחידה ב-Python.

# דוגמה זו מדגימה כיצד ליצור מסמך XBRL ולהוסיף אובייקט Unit
from aspose.finance.xbrl import XbrlDocument,Unit,QualifiedName,UnitType

# הנתיב לספריית המסמכים.
outputFile = "C:\\Files\\document.xbrl"

# צור מסמך XBRL
xbrlDoc = XbrlDocument()

# קבל איסוף מופעי מסמכים
xbrlInstances = xbrlDoc.xbrl_instances

# הוסף מופע לאוסף
xbrlInstance = xbrlInstances[xbrlInstances.add()]

# הוסף יחידה
unit = Unit(UnitType.MEASURE)
unit.measure_qualified_names.append(QualifiedName("USD", "iso4217", "http://www.xbrl.org/2003/iso4217"))
xbrlInstance.units.append(unit)

# שמור את המסמך
xbrlDoc.save(outputFile)

הוסף פריט עובדה ב-XBRL באמצעות Python

עובדות ב-XBRL מוגדרות באמצעות רכיבי פריט. פריט ב-XBRL מכיל את הערך של העובדה הפשוטה והתייחסות להקשר כדי לפרש נכון את העובדה הזו. אנו יכולים להוסיף פריט במסמך מופע XBRL על ידי ביצוע השלבים המפורטים להלן:

  1. ראשית, צור מופע של המחלקה XbrlDocument.
  2. הוסף מופע XBRL חדש ל-xbrlinstances של אובייקט XbrlDocument.
  3. הוסף הפניה לסכימה חדשה ל-schemarefs של אובייקט XbrlInstance.
  4. קבל את SchemaRef לפי האינדקס שלו מ-schemarefs.
  5. אתחל את מופע ההקשר והוסף אותו לאוסף ההקשרים.
  6. הגדר מופע Unit והוסף אותו לאוסף היחידות.
  7. צור מופע מחלקה Concept באמצעות השיטה getconceptbyname() .
  8. צור מופע של המחלקה Item עם האובייקט Concept כארגומנט.
  9. הגדר מאפייני פריט כגון contextref, unitref, דיוק, ערך וכו'.
  10. לאחר מכן, הוסף את הפריט לאוסף העובדות.
  11. לבסוף, שמור את קובץ ה-XBRL בשיטת save(string).

דוגמת הקוד הבאה מראה כיצד להוסיף עובדה כרכיב פריט במסמך מופע XBRL באמצעות Python.

# דוגמה זו מדגימה כיצד ליצור מסמך XBRL ולהוסיף אובייקט פריט
from datetime import datetime
from aspose.finance.xbrl import XbrlDocument,ContextPeriod,ContextEntity,Context,Unit,UnitType,QualifiedName,Item

# הנתיב לספריית המסמכים.
outputFile = "C:\\Files\\document.xbrl"
inputSchemaFile = "C:\\Files\\schema.xsd"

# צור מסמך XBRL
xbrlDoc = XbrlDocument()

# קבל איסוף מופעי מסמכים
xbrlInstances = xbrlDoc.xbrl_instances

# הוסף מופע לאוסף
xbrlInstance = xbrlInstances[xbrlInstances.add()]

# קבל אוסף הפניות לסכימת מופעים
schemaRefs = xbrlInstance.schema_refs

# הוסף סכימה
schemaRefs.add(inputSchemaFile, "example", "http://example.com/xbrl/taxonomy")
schema = schemaRefs[0]

# הוסף הקשר
contextPeriod = ContextPeriod(datetime(2020,1,1), datetime(2020,2,10))
contextEntity = ContextEntity("exampleIdentifierScheme", "exampleIdentifier")
context = Context(contextPeriod, contextEntity)
xbrlInstance.contexts.append(context)

# הוסף יחידה
unit = Unit(UnitType.MEASURE)
unit.measure_qualified_names.append(QualifiedName("USD", "iso4217", "http://www.xbrl.org/2003/iso4217"))
xbrlInstance.units.append(unit)

# הוסף פריט
fixedAssetsConcept = schema.get_concept_by_name("fixedAssets")
if fixedAssetsConcept is not None:
    item = Item(fixedAssetsConcept)
    item.context_ref = context
    item.unit_ref = unit
    item.precision = 4
    item.value = "1444"
    xbrlInstance.facts.append(item)
    
# שמור את המסמך
xbrlDoc.save(outputFile)

אנו יכולים להוסיף קישור להערת שוליים במסמך מופע XBRL על ידי ביצוע השלבים המפורטים להלן:

  1. ראשית, צור מופע של המחלקה XbrlDocument.
  2. הוסף מופע XBRL חדש ל-xbrlinstances של אובייקט XbrlDocument.
  3. הוסף הפניה לסכימה חדשה ל-schemarefs של אובייקט XbrlInstance.
  4. קבל את SchemaRef לפי האינדקס שלו מ-schemarefs.
  5. אתחל את מופע ההקשר והוסף אותו לאוסף ההקשרים.
  6. הגדר מופע מחלקה של הערת שוליים והגדר את התווית והטקסט שלו.
  7. אתחול סוג Locator באמצעות מופע המחלקה Loc.
  8. הגדר אובייקט FootnoteArc עם תווית Locator ותווית Footnote כארגומנטים.
  9. צור מופע של המחלקה FootnoteLink.
  10. הוסף את Note Footnote, Locator ו-FootnoteArc לאוספים רלוונטיים.
  11. לאחר מכן, הוסף את ה-FootnoteLink לאוסף ה-footnotelinks.
  12. לבסוף, שמור את קובץ ה-XBRL בשיטת save(string).

דוגמת הקוד הבאה מראה כיצד להוסיף קישור להערת שוליים במסמך מופע XBRL באמצעות Python.

# דוגמה זו מדגימה כיצד ליצור מסמך XBRL ולהוסיף אובייקט קישור של הערת שוליים
from datetime import datetime
from aspose.finance.xbrl import XbrlDocument,ContextPeriod,ContextEntity,Context,FootnoteLink,Footnote,Loc,FootnoteArc

# הנתיב לספריית המסמכים.
outputFile = "C:\\Files\\document.xbrl"
inputSchemaFile = "C:\\Files\\schema.xsd"

# צור מסמך XBRL
xbrlDoc = XbrlDocument()

# קבל איסוף מופעי מסמכים
xbrlInstances = xbrlDoc.xbrl_instances

# הוסף מופע לאוסף
xbrlInstance = xbrlInstances[xbrlInstances.add()]

# קבל אוסף הפניות לסכימת מופעים
schemaRefs = xbrlInstance.schema_refs

# הוסף סכימה
schemaRefs.add(inputSchemaFile, "example", "http://example.com/xbrl/taxonomy")
schema = schemaRefs[0]

# הוסף הקשר
contextPeriod = ContextPeriod(datetime(2020,1,1), datetime(2020,2,10))
contextEntity = ContextEntity("exampleIdentifierScheme", "exampleIdentifier")
context = Context(contextPeriod, contextEntity)
xbrlInstance.contexts.append(context)

# הוסף הערת שוליים
footnote = Footnote("footnote1")
footnote.text = "Including the effects of the merger."

# הוסף מיקום
loc = Loc("#cd1", "fact1")

# הגדר את קשת הערות השוליים
footnoteArc = FootnoteArc(loc.label, footnote.label)

# הוסף הערת שולייםLink
footnoteLink = FootnoteLink()
footnoteLink.footnotes.append(footnote)
footnoteLink.locators.append(loc)
footnoteLink.footnote_arcs.append(footnoteArc)
xbrlInstance.footnote_links.append(footnoteLink)
    
# שמור את המסמך
xbrlDoc.save(outputFile)

הכנס עזר לתפקיד ב-XBRL באמצעות Python

אנו יכולים להוסיף הפניה לתפקיד במסמך מופע XBRL על ידי ביצוע השלבים המפורטים להלן:

  1. ראשית, צור מופע של המחלקה XbrlDocument.
  2. הוסף מופע XBRL חדש ל-xbrlinstances של אובייקט XbrlDocument.
  3. הוסף הפניה לסכימה חדשה ל-schemarefs של אובייקט XbrlInstance.
  4. קבל את SchemaRef לפי האינדקס שלו מ-schemarefs.
  5. לאחר מכן, קבל את ה-RoleType מהשיטה getroletypebyuri()‎.
  6. לאחר מכן, צור מופע של המחלקה RoleReference עם האובייקט RoleType כארגומנט.
  7. לאחר מכן, הוסף את RoleReference לאוסף rolerefferences.
  8. לבסוף, שמור את קובץ XBRL בשיטת save(string).

דוגמת הקוד הבאה מראה כיצד להוסיף הפניה לתפקיד במסמך מופע XBRL באמצעות Python.

# דוגמה זו מדגימה כיצד ליצור מסמך XBRL ולהוסיף אובייקט התייחסות לתפקיד
from aspose.finance.xbrl import XbrlDocument,RoleReference

# הנתיב לספריית המסמכים.
outputFile = "C:\\Files\\document.xbrl"
inputSchemaFile = "C:\\Files\\schema.xsd"

# צור מסמך XBRL
xbrlDoc = XbrlDocument()

# קבל איסוף מופעי מסמכים
xbrlInstances = xbrlDoc.xbrl_instances

# הוסף מופע לאוסף
xbrlInstance = xbrlInstances[xbrlInstances.add()]

# קבל אוסף הפניות לסכימת מופעים
schemaRefs = xbrlInstance.schema_refs

# הוסף סכימה
schemaRefs.add(inputSchemaFile, "example", "http://example.com/xbrl/taxonomy")
schema = schemaRefs[0]

# קבל סוג תפקיד
roleType = schema.get_role_type_by_uri("http://abc.com/role/link1")

# הוסף הפניה לתפקיד
if roleType is not None:
    roleReference = RoleReference(roleType)
    xbrlInstance.role_references.append(roleReference)

# שמור את המסמך
xbrlDoc.save(outputFile)

הוסף התייחסות לתפקיד קשת ל-XBRL ב-Python

אנו יכולים להוסיף הפניה לתפקיד Arc במסמך מופע XBRL על ידי ביצוע השלבים המפורטים להלן:

  1. ראשית, צור מופע של המחלקה XbrlDocument.
  2. הוסף מופע XBRL חדש ל-xbrlinstances של אובייקט XbrlDocument.
  3. הוסף הפניה לסכימה חדשה ל-schemarefs של אובייקט XbrlInstance.
  4. קבל את SchemaRef לפי האינדקס שלו מ-schemarefs.
  5. לאחר מכן, קבל את ה-RoleType מהשיטה ()getarcroletypebyuri.
  6. לאחר מכן, צור מופע של המחלקה ArcroleReference עם האובייקט RoleType כארגומנט.
  7. לאחר מכן, הוסף את ArcroleReference לאוסף arcrolereferences.
  8. לבסוף, שמור את קובץ XBRL בשיטת save(string).

דוגמת הקוד הבאה מראה כיצד להוסיף הפניה לתפקיד קשת במסמך מופע XBRL באמצעות Python.

# דוגמה זו מדגימה כיצד ליצור מסמך XBRL ולהוסיף אובייקט התייחסות ל-Arc Role
from aspose.finance.xbrl import XbrlDocument,ArcroleReference

# הנתיב לספריית המסמכים.
outputFile = "C:\\Files\\document.xbrl"
inputSchemaFile = "C:\\Files\\schema.xsd"

# צור מסמך XBRL
xbrlDoc = XbrlDocument()

# קבל איסוף מופעי מסמכים
xbrlInstances = xbrlDoc.xbrl_instances

# הוסף מופע לאוסף
xbrlInstance = xbrlInstances[xbrlInstances.add()]

# קבל אוסף הפניות לסכימת מופעים
schemaRefs = xbrlInstance.schema_refs

# הוסף סכימה
schemaRefs.add(inputSchemaFile, "example", "http://example.com/xbrl/taxonomy")
schema = schemaRefs[0]

# קבל סוג תפקיד
roleType = schema.get_role_type_by_uri("http://abc.com/role/link1")

# הוסף הפניה לתפקיד
if roleType is not None:
    arcroleReference = ArcroleReference(roleType)
    xbrlInstance.arcrole_references.append(arcroleReference)

# שמור את המסמך
xbrlDoc.save(outputFile)

קבל רישיון חינם

אתה יכול לקבל רישיון זמני בחינם כדי לנסות את הספרייה ללא מגבלות הערכה.

סיכום

במאמר זה, למדנו כיצד ליצור מסמך XBRL באמצעות Python. ראינו גם כיצד להוסיף אובייקטי XBRL שונים למסמך מופע XBRL שנוצר באופן תוכנתי. חוץ מזה, אתה יכול ללמוד עוד על Aspose.Finance for Python API באמצעות תיעוד. בכל מקרה של אי בהירות, אנא אל תהסס לפנות אלינו בפורום שלנו.

ראה גם