notebooks/read_dimension.ipynb

{"cells":[{"cell_type":"markdown","metadata":{},"source":["# Read Dimension\n","\n","同一のディメンジョンのデータを収集する\n"]},{"cell_type":"code","execution_count":1,"metadata":{},"outputs":[],"source":["import os\n","from pathlib import Path\n","import edinet\n","\n","# サントリーホールディングス株式会社/H31.03.26 12:50\n","DOC_ID = \"S100FGSC\"\n","\n","# Data Folder\n","DATA_ROOT = Path.cwd().joinpath(\"data\")"]},{"cell_type":"markdown","metadata":{},"source":["## Download XBRL"]},{"cell_type":"code","execution_count":2,"metadata":{},"outputs":[{"name":"stderr","output_type":"stream","text":"c:\\Users\\tie301837\\Documents\\source\\xbrl_read_tutorial\\venv\\lib\\site-packages\\urllib3\\connectionpool.py:1004: InsecureRequestWarning: Unverified HTTPS request is being made. Adding certificate verification is strongly advised. See: https://urllib3.readthedocs.io/en/latest/advanced-usage.html#ssl-warnings\n  InsecureRequestWarning,\n"}],"source":["from edinet.xbrl_file import XBRLDir\n","\n","\n","# Download and load document\n","xbrl_path = edinet.api.document.get_xbrl(\n","    DOC_ID, save_dir=DATA_ROOT.joinpath(\"raw\"),\n","    expand_level=\"dir\")\n","\n","xbrl_dir = XBRLDir(xbrl_path)"]},{"cell_type":"markdown","metadata":{},"source":["## Find tags with same dimension and member\n","\n"]},{"cell_type":"code","execution_count":3,"metadata":{},"outputs":[],"source":["from lxml import etree\n","import pandas as pd\n","\n","\n","# Namespace is defined at\n","# http://www.xbrl.org/Specification/XBRL-2.1/REC-2003-12-31/XBRL-2.1-REC-2003-12-31+corrected-errata-2013-02-20.html#_1.6\n","# https://www.xbrl.org/specification/dimensions/rec-2012-01-25/dimensions-rec-2006-09-18+corrected-errata-2012-01-25-clean.html\n","\n","non_consolidated_dimension = \"jppfs_cor:ConsolidatedOrNonConsolidatedAxis\"\n","equity_axis = \"jppfs_cor:ComponentsOfEquityAxis\"\n","equity_member = \"jppfs_cor:ShareholdersEquityMember\"\n","non_consolidated_dimension\n","root = etree.parse(xbrl_dir.xbrl.path)\n","query = f\"\"\"\n","xbrli:context[\n","    xbrli:scenario[\n","        xbrldi:explicitMember[@dimension='{equity_axis}']\n","    ]\n","]\n","\"\"\"\n","\n","namespaces = {\n","    \"xbrli\": \"http://www.xbrl.org/2003/instance\",\n","    \"xbrldi\": \"http://xbrl.org/2006/xbrldi\"\n","}\n","\n","equities_on_equity_axis = root.xpath(query, namespaces=namespaces)\n","\n","\n","data = []\n","for e in equities_on_equity_axis:\n","    _id = e.attrib[\"id\"]\n","    member = e.find(f\".//xbrldi:explicitMember[@dimension='{equity_axis}']\",\n","                    namespaces=namespaces).text\n","\n","    period = \"\"\n","    period_begin = \"\"\n","    period_element = e.find(\".//xbrli:period/xbrli:instant\",\n","                            namespaces=namespaces)\n","    if period_element is not None:\n","        period = period_element.text\n","    else:\n","        period_element = e.find(\".//xbrli:period\", namespaces=namespaces)\n","        for p in period_element.getchildren():\n","            if p.tag.endswith(\"startDate\"):\n","                period_begin = p.text\n","            else:\n","                period = p.text\n","\n","    if _id and period:\n","        tag = xbrl_dir.xbrl.find(None, contextRef=_id)\n","        data.append({\n","            \"member\": member,\n","            \"period\": period,\n","            \"period_begin\": period_begin,\n","            \"element\": tag.element.name,\n","            \"value\": tag.text\n","        })\n","\n","equities = pd.DataFrame(data)"]},{"cell_type":"code","execution_count":4,"metadata":{},"outputs":[{"data":{"text/html":"<div>\n<style scoped>\n    .dataframe tbody tr th:only-of-type {\n        vertical-align: middle;\n    }\n\n    .dataframe tbody tr th {\n        vertical-align: top;\n    }\n\n    .dataframe thead th {\n        text-align: right;\n    }\n</style>\n<table border=\"1\" class=\"dataframe\">\n  <thead>\n    <tr style=\"text-align: right;\">\n      <th></th>\n      <th>member</th>\n      <th>period</th>\n      <th>period_begin</th>\n      <th>element</th>\n      <th>value</th>\n    </tr>\n  </thead>\n  <tbody>\n    <tr>\n      <th>0</th>\n      <td>jppfs_cor:ShareholdersEquityMember</td>\n      <td>2018-12-31</td>\n      <td></td>\n      <td>NetAssets</td>\n      <td>740191000000</td>\n    </tr>\n    <tr>\n      <th>1</th>\n      <td>jppfs_cor:CapitalStockMember</td>\n      <td>2018-12-31</td>\n      <td></td>\n      <td>NetAssets</td>\n      <td>70000000000</td>\n    </tr>\n    <tr>\n      <th>2</th>\n      <td>jppfs_cor:CapitalSurplusMember</td>\n      <td>2018-12-31</td>\n      <td></td>\n      <td>NetAssets</td>\n      <td>286367000000</td>\n    </tr>\n    <tr>\n      <th>24</th>\n      <td>jppfs_cor:RetainedEarningsBroughtForwardMember</td>\n      <td>2018-12-31</td>\n      <td></td>\n      <td>NetAssets</td>\n      <td>70243000000</td>\n    </tr>\n    <tr>\n      <th>25</th>\n      <td>jppfs_cor:TreasuryStockMember</td>\n      <td>2018-12-31</td>\n      <td></td>\n      <td>NetAssets</td>\n      <td>-938000000</td>\n    </tr>\n    <tr>\n      <th>26</th>\n      <td>jppfs_cor:ValuationAndTranslationAdjustmentsMe...</td>\n      <td>2018-12-31</td>\n      <td></td>\n      <td>NetAssets</td>\n      <td>2999000000</td>\n    </tr>\n    <tr>\n      <th>27</th>\n      <td>jppfs_cor:ValuationDifferenceOnAvailableForSal...</td>\n      <td>2018-12-31</td>\n      <td></td>\n      <td>NetAssets</td>\n      <td>6250000000</td>\n    </tr>\n    <tr>\n      <th>28</th>\n      <td>jppfs_cor:DeferredGainsOrLossesOnHedgesMember</td>\n      <td>2018-12-31</td>\n      <td></td>\n      <td>NetAssets</td>\n      <td>-3251000000</td>\n    </tr>\n    <tr>\n      <th>55</th>\n      <td>jppfs_cor:LegalCapitalSurplusMember</td>\n      <td>2018-12-31</td>\n      <td></td>\n      <td>NetAssets</td>\n      <td>17500000000</td>\n    </tr>\n    <tr>\n      <th>56</th>\n      <td>jppfs_cor:OtherCapitalSurplusMember</td>\n      <td>2018-12-31</td>\n      <td></td>\n      <td>NetAssets</td>\n      <td>268867000000</td>\n    </tr>\n    <tr>\n      <th>57</th>\n      <td>jppfs_cor:RetainedEarningsMember</td>\n      <td>2018-12-31</td>\n      <td></td>\n      <td>NetAssets</td>\n      <td>384762000000</td>\n    </tr>\n    <tr>\n      <th>58</th>\n      <td>jppfs_cor:ReserveForSpecialDepreciationMember</td>\n      <td>2018-12-31</td>\n      <td></td>\n      <td>NetAssets</td>\n      <td>33000000</td>\n    </tr>\n    <tr>\n      <th>59</th>\n      <td>jppfs_cor:ReserveForAdvancedDepreciationOfNonc...</td>\n      <td>2018-12-31</td>\n      <td></td>\n      <td>NetAssets</td>\n      <td>1785000000</td>\n    </tr>\n    <tr>\n      <th>60</th>\n      <td>jppfs_cor:GeneralReserveMember</td>\n      <td>2018-12-31</td>\n      <td></td>\n      <td>NetAssets</td>\n      <td>312700000000</td>\n    </tr>\n  </tbody>\n</table>\n</div>","text/plain":"                                               member      period  \\\n0                  jppfs_cor:ShareholdersEquityMember  2018-12-31   \n1                        jppfs_cor:CapitalStockMember  2018-12-31   \n2                      jppfs_cor:CapitalSurplusMember  2018-12-31   \n24     jppfs_cor:RetainedEarningsBroughtForwardMember  2018-12-31   \n25                      jppfs_cor:TreasuryStockMember  2018-12-31   \n26  jppfs_cor:ValuationAndTranslationAdjustmentsMe...  2018-12-31   \n27  jppfs_cor:ValuationDifferenceOnAvailableForSal...  2018-12-31   \n28      jppfs_cor:DeferredGainsOrLossesOnHedgesMember  2018-12-31   \n55                jppfs_cor:LegalCapitalSurplusMember  2018-12-31   \n56                jppfs_cor:OtherCapitalSurplusMember  2018-12-31   \n57                   jppfs_cor:RetainedEarningsMember  2018-12-31   \n58      jppfs_cor:ReserveForSpecialDepreciationMember  2018-12-31   \n59  jppfs_cor:ReserveForAdvancedDepreciationOfNonc...  2018-12-31   \n60                     jppfs_cor:GeneralReserveMember  2018-12-31   \n\n   period_begin    element         value  \n0                NetAssets  740191000000  \n1                NetAssets   70000000000  \n2                NetAssets  286367000000  \n24               NetAssets   70243000000  \n25               NetAssets    -938000000  \n26               NetAssets    2999000000  \n27               NetAssets    6250000000  \n28               NetAssets   -3251000000  \n55               NetAssets   17500000000  \n56               NetAssets  268867000000  \n57               NetAssets  384762000000  \n58               NetAssets      33000000  \n59               NetAssets    1785000000  \n60               NetAssets  312700000000  "},"execution_count":4,"metadata":{},"output_type":"execute_result"}],"source":["equities[(equities[\"period\"] == \"2018-12-31\") & (equities[\"period_begin\"] == \"\")]"]},{"cell_type":"code","execution_count":null,"metadata":{},"outputs":[],"source":[]}],"nbformat":4,"nbformat_minor":2,"metadata":{"language_info":{"name":"python","codemirror_mode":{"name":"ipython","version":3},"version":"3.7.4"},"orig_nbformat":2,"file_extension":".py","mimetype":"text/x-python","name":"python","npconvert_exporter":"python","pygments_lexer":"ipython3","version":3}}