قم بإنشاء ملف XBRL باستخدام Python

مستند XBRL عبارة عن مجموعة من الحقائق التي تشكل معًا تقريرًا تجاريًا. يمكننا بسهولة إنشاء مستند مثيل XBRL برمجيًا وإضافة كائنات أو عناصر مثل مرجع المخطط ، والسياق ، والوحدة ، والعناصر ، إلخ. في هذه المقالة ، سوف نتعلم كيفية إنشاء ملف XBRL باستخدام Python.

سيتم تناول الموضوعات التالية في هذه المقالة:

  1. ما هو XBRL
  2. مكتبة بايثون المالية لإنشاء ملفات XBRL
  3. إنشاء ملف XBRL
  4. إضافة مرجع مخطط إلى XBRL
  5. إضافة سياق في XBRL
  6. إنشاء وحدة في XBRL
  7. إضافة عنصر حقيقة في XBRL
  8. إضافة روابط حاشية سفلية إلى XBRL
  9. إدراج مرجع الدور في XBRL
  10. إضافة مرجع دور القوس إلى XBRL

ما هو XBRL

يرمز XBRL إلى لغة إعداد التقارير التجارية القابلة للتوسيع ، وهي لغة ترميز قائمة على 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.

يرجى إما تنزيل الحزمة أو تثبيت API من PyPI باستخدام أمر pip التالي في وحدة التحكم:

pip install aspose-finance

قم بإنشاء مستند مثيل XBRL في Python

يمكننا بسهولة إنشاء مستند مثيل XBRL من البداية باتباع الخطوات الواردة أدناه:

  1. أولاً ، قم بإنشاء مثيل لفئة XbrlDocument.
  2. بعد ذلك ، قم بالوصول إلى مجموعة المثيلات من كائن XbrlDocument إلى كائن xbrlinstances.
  3. بعد ذلك ، قم بإضافة مثيل XBRL جديد باستخدام طريقة xbrlinstances.add().
  4. أخيرًا ، احفظ ملف XBRL باستخدام طريقة الحفظ (السلسلة).يأخذ مسار ملف الإخراج كوسيطة.

يوضح نموذج التعليمات البرمجية التالي كيفية إنشاء مثيل 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 الذي تم إنشاؤه حديثًا.

أضف مرجع مخطط إلى XBRL باستخدام Python

يمكننا إضافة مرجع مخطط في مستند مثيل XBRL باتباع الخطوات الواردة أدناه:

  1. أولاً ، قم بإنشاء مثيل لفئة XbrlDocument.
  2. بعد ذلك ، احصل على مجموعة مثيلات كائن XbrlDocument في كائن xbrlinstances.
  3. ثم قم بإضافة مثيل XBRL جديد باستخدام أسلوب xbrlinstances.add().
  4. بعد ذلك ، احصل على مجموعة مرجع مخطط كائن XbrlInstance في كائن schemarefs.
  5. بعد ذلك ، قم بإضافة مرجع مخطط جديد باستخدام طريقة schemarefs.add() مع ملف مخطط الإدخال.
  6. أخيرًا ، احفظ ملف XBRL باستخدام طريقة الحفظ (السلسلة).

يوضح نموذج التعليمات البرمجية التالي كيفية إنشاء مستند مثيل 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. بعد ذلك ، قم بإنشاء مثيل لفئة السياق مع ContextPeriod و ContextEntity المعرفة.
  6. بعد ذلك ، أضف كائن السياق إلى مجموعة السياقات.
  7. أخيرًا ، احفظ ملف XBRL باستخدام طريقة الحفظ (السلسلة).

يوضح نموذج التعليمات البرمجية التالي كيفية إنشاء مستند مثيل XBRL وإضافة كائن سياق في Python.

# يوضح مثال التعليمات البرمجية هذا كيفية إنشاء مستند XBRL وإضافة كائن سياق
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. بعد ذلك ، قم بإنشاء مثيل لفئة الوحدة باستخدام نوع الوحدة كقياس.
  4. بعد ذلك ، أضف QualifiedName إلى مجموعة Measqualifiednames.
  5. بعد ذلك ، أضف الوحدة إلى مجموعة الوحدات.
  6. أخيرًا ، احفظ ملف XBRL باستخدام طريقة الحفظ (السلسلة).

يوضح نموذج التعليمات البرمجية التالي كيفية إنشاء ملف XBRL وإضافة كائن وحدة في Python.

# يوضح مثال التعليمات البرمجية هذا كيفية إنشاء مستند XBRL وإضافة كائن الوحدة
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. قم بإضافة مرجع مخطط جديد إلى مخططات كائن XbrlInstance.
  4. احصل على SchemaRef من خلال فهرسها من المخططات.
  5. قم بتهيئة مثيل السياق وإضافته إلى مجموعة السياقات.
  6. حدد مثيل الوحدة وأضفه إلى مجموعة الوحدات.
  7. قم بإنشاء مثيل لفئة المفهوم باستخدام طريقة getconceptbyname().
  8. قم بإنشاء مثيل لفئة العنصر باستخدام كائن Concept كوسيطة.
  9. قم بتعيين خصائص العنصر مثل Contextref و unitref والدقة والقيمة وما إلى ذلك.
  10. بعد ذلك ، أضف العنصر إلى مجموعة الحقائق.
  11. أخيرًا ، احفظ ملف XBRL باستخدام طريقة الحفظ (السلسلة).

يوضح نموذج التعليمات البرمجية التالي كيفية إضافة حقيقة كعنصر عنصر في مستند مثيل 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. قم بإضافة مرجع مخطط جديد إلى مخططات كائن XbrlInstance.
  4. احصل على SchemaRef من خلال فهرسها من المخططات.
  5. قم بتهيئة مثيل السياق وإضافته إلى مجموعة السياقات.
  6. تحديد مثيل فئة حاشية سفلية وتعيين تسميتها ونصها.
  7. تهيئة نوع محدد المواقع باستخدام مثيل فئة Loc.
  8. قم بتعريف كائن FootnoteArc باستخدام تسمية محدد المواقع وتسمية الحاشية السفلية كوسائط.
  9. قم بإنشاء مثيل لفئة FootnoteLink.
  10. أضف حاشية سفلية ومحدد موقع وخط حاشية سفلية للمجموعات ذات الصلة.
  11. بعد ذلك ، قم بإضافة ارتباط الحاشية السفلية إلى مجموعة الروابط السفلية.
  12. أخيرًا ، احفظ ملف XBRL باستخدام طريقة الحفظ(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. قم بإضافة مرجع مخطط جديد إلى مخططات كائن XbrlInstance.
  4. احصل على SchemaRef من خلال فهرسها من المخططات.
  5. بعد ذلك ، احصل على نوع الدور من طريقة getroletypebyuri().
  6. بعد ذلك ، قم بإنشاء مثيل للفئة RoleReference باستخدام كائن RoleType كوسيطة.
  7. بعد ذلك ، أضف دور مرجع إلى مجموعة مراجع الأدوار.
  8. أخيرًا ، احفظ ملف XBRL باستخدام طريقة الحفظ (السلسلة).

يوضح نموذج التعليمات البرمجية التالي كيفية إضافة مرجع دور في مستند مثيل 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. قم بإضافة مرجع مخطط جديد إلى مخططات كائن XbrlInstance.
  4. احصل على SchemaRef من خلال فهرسها من المخططات.
  5. بعد ذلك ، احصل على نوع الدور من طريقة getarcroletypebyuri().
  6. بعد ذلك ، قم بإنشاء مثيل لفئة ArcroleReference باستخدام كائن RoleType كوسيطة.
  7. بعد ذلك ، أضف ArcroleReference إلى مجموعة المراجع القوسية.
  8. أخيرًا ، احفظ ملف XBRL باستخدام طريقة الحفظ (السلسلة).

يوضح نموذج التعليمات البرمجية التالي كيفية إضافة مرجع دور القوس في مستند مثيل XBRL باستخدام Python.

# يوضح مثال الرمز هذا كيفية إنشاء مستند XBRL وإضافة كائن مرجعي لدور القوس
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 باستخدام التوثيق. في حالة وجود أي غموض ، لا تتردد في الاتصال بنا على المنتدى.

أنظر أيضا