Skip to content
Extraits de code Groupes Projets
file_handling.html 12,9 ko
Newer Older
  • Learn to ignore specific revisions
  • Nicolas Roisin's avatar
    Nicolas Roisin a validé
    <!doctype html>
    <html lang="en">
    <head>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1">
    <meta name="generator" content="pdoc3 0.11.6">
    <title>dopes.data_analysis.file_handling API documentation</title>
    <meta name="description" content="">
    <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/sanitize.min.css" integrity="sha512-y1dtMcuvtTMJc1yPgEqF0ZjQbhnc/bFhyvIyVNb9Zk5mIGtqVaAB1Ttl28su8AvFMOY0EwRbAe+HCLqj6W7/KA==" crossorigin>
    <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/typography.min.css" integrity="sha512-Y1DYSb995BAfxobCkKepB1BqJJTPrOp3zPL74AWFugHHmmdcvO+C48WLrUOlhGMc0QG7AE3f7gmvvcrmX2fDoA==" crossorigin>
    <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/default.min.css" crossorigin>
    <style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:1.5em;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:2em 0 .50em 0}h3{font-size:1.4em;margin:1.6em 0 .7em 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .2s ease-in-out}a:visited{color:#503}a:hover{color:#b62}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900;font-weight:bold}pre code{font-size:.8em;line-height:1.4em;padding:1em;display:block}code{background:#f3f3f3;font-family:"DejaVu Sans Mono",monospace;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source > summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible;min-width:max-content}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em 1em;margin:1em 0}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
    <style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul ul{padding-left:1em}.toc > ul > li{margin-top:.5em}}</style>
    <style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
    <script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js" integrity="sha512-D9gUyxqja7hBtkWpPWGt9wfbfaMGVt9gnyCvYa+jojwwPHLCzUm5i8rpk7vD7wNee9bA35eYIjobYPaQuKS1MQ==" crossorigin></script>
    <script>window.addEventListener('DOMContentLoaded', () => {
    hljs.configure({languages: ['bash', 'css', 'diff', 'graphql', 'ini', 'javascript', 'json', 'plaintext', 'python', 'python-repl', 'rust', 'shell', 'sql', 'typescript', 'xml', 'yaml']});
    hljs.highlightAll();
    /* Collapse source docstrings */
    setTimeout(() => {
    [...document.querySelectorAll('.hljs.language-python > .hljs-string')]
    .filter(el => el.innerHTML.length > 200 && ['"""', "'''"].includes(el.innerHTML.substring(0, 3)))
    .forEach(el => {
    let d = document.createElement('details');
    d.classList.add('hljs-string');
    d.innerHTML = '<summary>"""</summary>' + el.innerHTML.substring(3);
    el.replaceWith(d);
    });
    }, 100);
    })</script>
    </head>
    <body>
    <main>
    <article id="content">
    <header>
    <h1 class="title">Module <code>dopes.data_analysis.file_handling</code></h1>
    </header>
    <section id="section-intro">
    </section>
    <section>
    </section>
    <section>
    </section>
    <section>
    <h2 class="section-title" id="header-functions">Functions</h2>
    <dl>
    <dt id="dopes.data_analysis.file_handling.read_file"><code class="name flex">
    <span>def <span class="ident">read_file</span></span>(<span>file_path,<br>comments='#',<br>delimiter=',',<br>skip_header=0,<br>skip_footer=0,<br>max_rows=None,<br>usecols=None,<br>deletechars=&quot; !#$%&amp;&#x27;()*+, /:;&lt;=&gt;?@[\\]^{|}~&quot;)</span>
    </code></dt>
    <dd>
    <details class="source">
    <summary>
    <span>Expand source code</span>
    </summary>
    <pre><code class="python">def read_file(file_path,comments=comments,delimiter=delimiter, skip_header=skip_header,skip_footer=skip_footer,
                        max_rows=max_rows,usecols=usecols, deletechars=deletechars):
        &#34;&#34;&#34; Function to read data from a file
        
            args:
                - file_path (string) : file, filename, list, or generator to read.
                - comments (char) : the character used to indicate the start of a comment.
                - delimiter (char) : the string used to separate values.
                - skip_header (integer or sequence) : the number of lines to skip at the beginning of the file.
                - skip_footer (integer or sequence) : the number of lines to skip at the end of the file.
                - max_rows (integer) : the maximum number of rows to read. Must not be used with skip_footer at the same time.
                - usecols (sequence) : which columns to read, with 0 being the first. For example, usecols = (1, 4, 5) will extract the 2nd, 5th and 6th columns.
                - deletechars (string) : a string combining invalid characters that must be deleted from the names.
        
            return:
                - data (numpy array): numpy array of the data read from the file
        &#34;&#34;&#34;          
        data=np.genfromtxt(file_path,comments=comments,delimiter=delimiter,
                            skip_header=skip_header,skip_footer=skip_footer,
                            max_rows=max_rows,usecols=usecols, deletechars=deletechars)
        
        return data</code></pre>
    </details>
    <div class="desc"><p>Function to read data from a file</p>
    <p>args:
    - file_path (string) : file, filename, list, or generator to read.
    - comments (char) : the character used to indicate the start of a comment.
    - delimiter (char) : the string used to separate values.
    - skip_header (integer or sequence) : the number of lines to skip at the beginning of the file.
    - skip_footer (integer or sequence) : the number of lines to skip at the end of the file.
    - max_rows (integer) : the maximum number of rows to read. Must not be used with skip_footer at the same time.
    - usecols (sequence) : which columns to read, with 0 being the first. For example, usecols = (1, 4, 5) will extract the 2nd, 5th and 6th columns.
    - deletechars (string) : a string combining invalid characters that must be deleted from the names.</p>
    <p>return:
    - data (numpy array): numpy array of the data read from the file</p></div>
    </dd>
    <dt id="dopes.data_analysis.file_handling.write_in_file"><code class="name flex">
    <span>def <span class="ident">write_in_file</span></span>(<span>file_path, data, delimiter=',', overwrite=False, header=None, date=True, comment='#')</span>
    </code></dt>
    <dd>
    <details class="source">
    <summary>
    <span>Expand source code</span>
    </summary>
    <pre><code class="python">def write_in_file(file_path,data,delimiter=&#34;,&#34;,overwrite=False,header=None,date=True, comment=&#34;#&#34;):
        &#34;&#34;&#34; Function to write data in a file
        
            args:
                - file_path (string) : path for the data file, including the filename with its extension
                - data (scalar, list or array) : the data to be written in the file
                - delimiter (char) : the delimiter to separate the column of the data
                - overwrite (boolean) : if True overwrite the existing file if any, if False, append the data to the existing file if any
                - header (string) : header to be written before the data
                - date (boolean) : date to be written at the beginning of the file
                - comment (char) : char to be written before the header and date to indicate non-data lines
        
        &#34;&#34;&#34;        
        if file_path.split(&#34;.&#34;)[-1]==&#34;csv&#34;:
            delimiter=&#34;,&#34;
            
        # Create file and header
        if overwrite:
            f = open(file_path, &#34;w&#34;)
        else:
            f = open(file_path, &#34;a&#34;)
            
        if date:
            f.write(&#34;%s %s\n&#34;%(comment,datetime.datetime.now().strftime(&#34;%c&#34;)))
        
        if isinstance(header, str):
            for line in header.split(&#34;\n&#34;):
                f.write(comment+&#34; &#34;+line+&#34;\n&#34;)
    
        
        shape=np.shape(data)
        if len(shape)==0:
            f.write(&#34;%.6E\n&#34;%(data))
        elif len(shape)==1:
            for i in range(shape[0]):
                if i==0:
                    f.write(&#34;%.6E&#34;%(data[i]))
                else:
                    f.write(&#34;%s%.6E&#34;%(delimiter,data[i]))
    
            f.write(&#34;\n&#34;)
    
        elif len(shape)==2:
            for i in range(shape[0]):
                for j in range(shape[1]):
                    if j==0:
                        f.write(&#34;%.6E&#34;%(data[i,j]))
                    else:
                        f.write(&#34;%s%.6E&#34;%(delimiter,data[i,j]))
                f.write(&#34;\n&#34;)                
        f.close()</code></pre>
    </details>
    <div class="desc"><p>Function to write data in a file</p>
    <p>args:
    - file_path (string) : path for the data file, including the filename with its extension
    - data (scalar, list or array) : the data to be written in the file
    - delimiter (char) : the delimiter to separate the column of the data
    - overwrite (boolean) : if True overwrite the existing file if any, if False, append the data to the existing file if any
    - header (string) : header to be written before the data
    - date (boolean) : date to be written at the beginning of the file
    - comment (char) : char to be written before the header and date to indicate non-data lines</p></div>
    </dd>
    </dl>
    </section>
    <section>
    </section>
    </article>
    <nav id="sidebar">
    <div class="toc">
    <ul></ul>
    </div>
    <ul id="index">
    <li><h3>Super-module</h3>
    <ul>
    <li><code><a title="dopes.data_analysis" href="index.html">dopes.data_analysis</a></code></li>
    </ul>
    </li>
    <li><h3><a href="#header-functions">Functions</a></h3>
    <ul class="">
    <li><code><a title="dopes.data_analysis.file_handling.read_file" href="#dopes.data_analysis.file_handling.read_file">read_file</a></code></li>
    <li><code><a title="dopes.data_analysis.file_handling.write_in_file" href="#dopes.data_analysis.file_handling.write_in_file">write_in_file</a></code></li>
    </ul>
    </li>
    </ul>
    </nav>
    </main>
    <footer id="footer">
    <p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.11.6</a>.</p>
    </footer>
    </body>
    </html>