Code Monkey home page Code Monkey logo

linescan.py's Introduction

linescan.py

Easily read a text file using counting numbers.

linescan.py is a simple module designed to aid beginner programmers who need to read data from text files but have trouble setting up open() or translating real numbers to counting numbers.

Features

  • Uses counting numbers to denote line numbers instead of zero-based indexing
  • Simple API
  • Supports >= Python 3.6

Usage

import linescan

# Scan a single line using UTF-8 encoding
linescan.scan("MyFile.txt", 12, 12, encoding="utf-8")

# Scan multiple lines using default encoding
linescan.scan("MyFile.txt", 1, 12)

# Scan entire file
linescan.scan("MyFile.txt", 1)

# Passing a value of `True` will raise Exceptions instead of returning `False`
# Pass a value of `False` to restore default behavior
linescan.show_errors(True)

API Documentation

Complete API documentation is available on the wiki.

License

2013-2018 Caleb Ely

MIT

linescan.py's People

Contributors

le717 avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar

linescan.py's Issues

Examples/tests for rescan() function

I need some examples for the rescan() function. I was forgot exactly how to use it and had no examples showing how while reworking the script with OOP.

Run examples on Travis CI

I have to figure out how to run the examples on Travis CI. They would then serve as tests to ensure everything worked and as user-examples.

  • Fix ImportError
  • Prevent requesting user input on Travis (it is not possible)

Restructure in OOP

I think linescan is simple enough that I could restructure it in OOP. It would help me learn that programming paradigm too.

linescan.rescan()

Possibly duplicate linecache.checkcache() functionality for updating any stored scans. It would probably not recheck all stored files, thus it would require the file name. (though all scans could be rescanned). Line numbers would not be needed, as the existing numbers would be used.

Parameter renaming

  • endLine parameter changed to endline
  • errorValue parameter changed to errorvalue

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.