Skip to main content

Parse comments from various source files.

Project description

Comment Parser

Run Tests PyPI status PyPI version shields.io PyPI license PyPI pyversions

Python module used to extract comments from source code files of various types.

Installation

Prerequisites

  • libmagic

Linux/Unix

sudo pip3 install comment_parser

OSX and Windows

Additionally, complete the special installation requirements for python-magic.

Usage

To use, simply run:

>>> from comment_parser import comment_parser
>>> # Returns a list of comment_parser.parsers.common.Comments
>>> comment_parser.extract_comments('/path/to/source_file')
>>> # Or
>>> comment_parser.extract_comments_from_str('...')

extract_comments signatures

def extract_comments(filename, mime=None):
    """Extracts and returns the comments from the given source file.

    Args:
        filename: String name of the file to extract comments from.
        mime: Optional MIME type for file (str). Note some MIME types accepted
            don't comply with RFC2045. If not given, an attempt to deduce the
            MIME type will occur.
    Returns:
        Python list of parsers.common.Comment in the order that they appear in
            the source file.
    Raises:
        UnsupportedError: If filename is of an unsupported MIME type.
    """
    pass


def extract_comments_from_str(code, mime=None):
    """Extracts and returns comments from the given source string.

    Args:
        code: String containing code to extract comments from.
        mime: Optional MIME type for code (str). Note some MIME types accepted
            don't comply with RFC2045. If not given, an attempt to deduce the
            MIME type will occur.
    Returns:
        Python list of parsers.common.Comment in the order that they appear in
            the source code.
    Raises:
        UnsupportedError: If code is of an unsupported MIME type.
    """
    pass

Comments Interface

class Comment(object):
    """Represents comments found in source files."""
    def text(self):
        """Returns the comment's text.
        Returns:
            String
        """
        pass

    def line_number(self):
        """Returns the line number the comment was found on.
        Returns:
            Int
        """
        pass

    def is_multiline(self):
        """Returns whether this comment was a multiline comment.
        Returns:
            True if comment was a multiline comment, False if not.
        """
       pass

    def __str__(self):
        pass

    def __eq__(self, other):
        pass

Development

Install Dependencies

pip install -r requirements.txt -r requirements-dev.txt

Running locally

Start python in the base of repository.

from comment_parser import comment_parser
comment_parser.extract_comments('foo.c', mime='text/x-c')

Running tests

python -m pytest

Running pylint

pylint comment_parser

Running formatter

yapf -rip .

Deploying to PyPi

python setup.py sdist
twine upload dist/*

Supported Programming Languages

Language Mime String
C text/x-c
C++/C# text/x-c++
Go text/x-go
HTML text/html
Java text/x-java-source
Javascript application/javascript
Python text/x-python
Python text/x-script.python
Ruby text/x-ruby
Shell text/x-shellscript
XML text/xml

And more to come!

Check comment_parser.py for corresponding MIME types.

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

comment_parser-1.2.5.tar.gz (8.9 kB view details)

Uploaded Source

File details

Details for the file comment_parser-1.2.5.tar.gz.

File metadata

  • Download URL: comment_parser-1.2.5.tar.gz
  • Upload date:
  • Size: 8.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for comment_parser-1.2.5.tar.gz
Algorithm Hash digest
SHA256 5606b769228cafce03d538e361472896581b386f3bc44bd62f4b61ff45ff05ec
MD5 d710cc70eda8de85cd920782aeb3b4bf
BLAKE2b-256 376a354d8e640b5f90996ac07c002189a552226a0ddaad85efd14863166aaa14

See more details on using hashes here.

Provenance

The following attestation bundles were made for comment_parser-1.2.5.tar.gz:

Publisher: deploy.yml on jeanralphaviles/comment_parser

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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