Skip to main content

An implementation of Apache Ant FileSet and Globs

Project description

Features

Formic is a Python implementation of Apache Ant FileSet and Globs including the directory wildcard **.

FileSet provides a terse way of specifying a set of files without having to enumerate individual files. It:

  1. Includes files from one or more Ant Globs, then

  2. Optionally excludes files matching further Ant Globs.

Ant Globs are a superset of ordinary file system globs. The key differences:

  • They match whole paths, eg /root/myapp/*.py

  • ** matches any directory or directories, eg /root/**/*.py matches /root/one/two/my.py

  • You can match the topmost directory or directories, eg /root/**, or

  • The parent directory of the file, eg **/parent/*.py, or

  • Any parent directory, eg **/test/**/*.py

This approach is the de-facto standard in several other languages and tools, including Apache Ant and Maven, Ruby (Dir) and Perforce (…).

Python has built-in support for simple globs in fnmatcher and glob, but Formic:

  • Can recursively scan subdirectories

  • Matches arbitrary directories in the path (eg /1/**/2/**/3/**/*.py).

  • Has a high level interface:

    • Specify one or more globs to find files

    • Globs can be used to exclude files

    • Ant, and Formic, has a set of default excludes. These are files and directories that, by default, are automatically excluded from all searches. The majority of these are files and directories related to VCS (eg .svn directories). Formic adds __pycache__.

    • Iterate through all matches in the sub-tree

  • Is more efficient with many common patterns; it runs relatively faster on large directory trees with large numbers of files.

Quickstart

Formic can be installed from the Cheeseshop with easy_install or pip:

$ easy_install formic

Once installed, you can use Formic either from the command line:

$ formic -i "*.py" -e "__init__.py" "**/*test*/" "test_*"

This will search for files all Python files under the current directory excluding all __init__.py files, any file in directories whose name contains the word ‘test’, and any files that start test_.

Or integrated right into your Python 2.7 project:

import formic
fileset = formic.FileSet(include="**.py",
                         exclude=["**/*test*/**", "test_*"]
                         )

for file_name in fileset:
    # Do something with file_name
    ...

That’s about it :)

About

Formic is written and maintained by Andrew Alcock of Aviser LLP, Singapore.

Formic is Copyright (C) 2012, Aviser LLP and released under GPLv3. Aviser LLP would be happy to discuss other licensing arrangements; for details, please email the maintainer.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

formic-0.9beta8.tar.gz (45.5 kB view details)

Uploaded Source

Built Distribution

formic-0.9beta8-py2.7.egg (69.8 kB view details)

Uploaded Egg

File details

Details for the file formic-0.9beta8.tar.gz.

File metadata

  • Download URL: formic-0.9beta8.tar.gz
  • Upload date:
  • Size: 45.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for formic-0.9beta8.tar.gz
Algorithm Hash digest
SHA256 d246d2f254579cad1d723076d4072079e2191e2e6da6a64617ea7f2107f340ec
MD5 90e10af96b60cf511fb1f8ab0c3e488f
BLAKE2b-256 6d2a69ad53513dd33c6c71b96a7fa80cd9e4441b903d8d22b169d6f7be9e58e6

See more details on using hashes here.

File details

Details for the file formic-0.9beta8-py2.7.egg.

File metadata

File hashes

Hashes for formic-0.9beta8-py2.7.egg
Algorithm Hash digest
SHA256 0b00adbd1924263a458c877236957eb818c113637f6c256a95801dc14dbf135b
MD5 ccf349b6d06a8daa552cb127fcd35954
BLAKE2b-256 a76c5f37d84d117722d5bf87c531a8436fb39cfa52cea1bda3ce24a44cf797df

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page