eduherminio / fileparser Goto Github PK

8.0 2.0 3.0 247 KB

C# file parser (.NET 6)

License: MIT License

C# 100.00%

text-parser fileparser net net-6 net-8

fileparser's Introduction

FileParser

FileParser is a .NET library designed to read text files line-by-line, saving each line's content into basic types vars (int, double, string, etc.).

.NET Framework 4.6 was supported until v1.4.x.
.NET Standard 2.0 and 2.1 were supported until v1.6.x.
Nullable is enabled from 1.6.x.

Purpose

This project was born with a very specific purpose: providing a tool with whom easily parse files with a known structure, ideally being as flexible and easy to use as C++ standard IO approach.

For those who don't understand what I mean, here's a simple Use Case (also reposited):

Given the following input.txt, which contains an integer n (>=0) followed by n doubles and a final string,

5   1.1 3.14159265 2.2265       5.5 10              fish

A simple .cpp snippet like the following one could process input.txt, providing that file is selected as standard input source:

./myExecutable < input.txt > output.txt

#include <iostream>
#include <list>
#include <string>

int main()
{
    int _integer;
    std::string _str;
    std::list<double> _list;
    double _auxdouble;

    // Input start;
    std::cin>>_integer;
    for(int i=0; i<_integer; ++i)
    {
        std::cin>>_auxdouble;
        _list.push_back(_auxdouble);
    }
    std::cin>>_str;
    // Input end

    // Data processing

    // Output start
    std::cout<<_integer<<" ";
    for(const double& d : _list)
        std::cout<<d<<" ";
    std::cout<<_str;
    // Output end

    return 0;
}

Seems effortless to process these kind of simple .txt files using C++, right?

Well, using C# things are not so straight-forward, and that's why FileParser was created for:

using System;
using System.Collections.Generic;
using System.Globalization;
using System.IO;

using FileParser;

namespace FileParserSample
{
    class Program
    {
        static void Main(string[] args)
        {
            var cultureInfo = new CultureInfo("en-US");
            CultureInfo.DefaultThreadCurrentCulture = cultureInfo;

            List<double> listDouble = new List<double>();
            string str;

            // Input start
            IParsedFile file = new ParsedFile("SimpleInput.txt");
            IParsedLine firstLine = file.NextLine();

            int _integer = firstLine.NextElement<int>();

            for(int i=0; i<_integer; ++i)
                listDouble.Add(firstLine.NextElement<double>());

            str = firstLine.NextElement<string>();
            // Input end

            // Data Processing

            // Output start
            StreamWriter writer = new StreamWriter("..\\CSharpSimpleOutput.txt");
            using (writer)
            {
                writer.WriteLine(_integer + " " + string.Join(null, listDouble));
            }
            // Output end
        }
    }
}

Documentation

I've done my best to create a WIKI describing FileParser API.

Besides the WIKI, some real (own) projects where it has been used are:

Contributing, issues, suggestions, doubts

If anyone else ever happens to use FileParser, I'll be happy to accept suggestions and solve any doubts.

Just open an issue :)

fileparser's People

Contributors

Stargazers

Watchers

Forkers

mahaveerjangidvam corstiaan84 piotri44

fileparser's Issues

Make non-public classes internal

Nowadays only IParsedFile. IParsedLine & FileReader are intended to be directly used.
Last one might not be exposed in the future in favour of more methods of IParsedFile.
Explicit public API needs to be created.

Add documentation

WIP, sorry for any inconvenient.

Fix 'Commit and push version increment' step in Azure DevOps

Despite ending up green, git push fails apparently due to status checks.
Tag is pushed correctly, though.
Only known workaround used in AoCHelper is disabling the Required status checks step in repo's configuration.

How about giving admin:repo_hook permissions to that Api Key?

Changes not staged for commit:
  (use "git add <file>..." to update what will be committed)
  (use "git restore <file>..." to discard changes in working directory)
	modified:   Examples/FileParserExample/FileParserExample.csproj
	modified:   NugetTest/NugetTest/NugetTest.csproj
	modified:   src/FileParser/FileParser.csproj

no changes added to commit (use "git add" and/or "git commit -a")
[master 7b94a97] Release v1.4.3
 3 files changed, 3 insertions(+), 3 deletions(-)
remote: error: GH006: Protected branch update failed for refs/heads/master.        
remote: error: 8 of 8 required status checks are expected.        
To https://github.com/eduherminio/FileParser
 ! [remote rejected] master -> master (protected branch hook declined)
error: failed to push some refs to 'https://github.com/eduherminio/FileParser'
To https://github.com/eduherminio/FileParser
 * [new tag]         v1.4.3 -> v1.4.3
Finishing: Commit and push version increment

Consider implementing 'interpolated parsing'

https://gist.github.com/akarpov89/03c53ea537451c7790341d7f697a89ec

https://twitter.com/akarpov89/status/1443957219834400773

Allow empty items

Hi,

Great clean library that works except for one flaw, the option to remove white space needs to be optional so that empty values between delimiters match up to the headers, without that it is impossible to know which data value goes with which header column, assuming the first line in csv file is the header column names.

The line to remove the white space in this method should be made optional with a bool parameter.

private static ICollection<string> ProcessLine(string original_line, string? separator)
     {
         List<string> wordsInLine = original_line
             .Split(separator?.ToCharArray())
             .Select(str => str.Trim()).ToList();

         wordsInLine.RemoveAll(string.IsNullOrWhiteSpace);   // Probably not needed, but just in case

         return wordsInLine;
     }

+-+++++
+-*++++
-+-%

Extract<char>(ref Queue<string>) might need to be implemented.

Force IOException in Linux while reading a file

The following test needs to be skipped since it fails in Travis CI env (no exception is thrown).

        [Fact(Skip ="No exception is thrown in Linux (CI env)")]
        void IOException()
        {
            string fileName = "Any.txt";
            StreamWriter writer = new StreamWriter(fileName);
            using (writer)
            {
                Assert.Throws<IOException>(() => FileReader.Parse(fileName));
            }
        }

If no way of forcing IOException in Linux is found, test would better be deleted.