383 lines
11 KiB
Python
383 lines
11 KiB
Python
# -*- coding: utf-8 -*-
|
|
"""
|
|
wakatime.stats
|
|
~~~~~~~~~~~~~~
|
|
|
|
Stats about files
|
|
|
|
:copyright: (c) 2013 Alan Hamlett.
|
|
:license: BSD, see LICENSE for more details.
|
|
"""
|
|
|
|
import logging
|
|
import os
|
|
import re
|
|
import sys
|
|
|
|
from .compat import u, open
|
|
from .constants import MAX_FILE_SIZE_SUPPORTED
|
|
from .dependencies import DependencyParser
|
|
from .exceptions import SkipHeartbeat
|
|
from .language_priorities import LANGUAGES
|
|
|
|
from .packages.pygments.lexers import (
|
|
_iter_lexerclasses,
|
|
_fn_matches,
|
|
basename,
|
|
ClassNotFound,
|
|
CppLexer,
|
|
find_lexer_class,
|
|
get_lexer_by_name,
|
|
)
|
|
from .packages.pygments.modeline import get_filetype_from_buffer
|
|
|
|
try:
|
|
from .packages import simplejson as json # pragma: nocover
|
|
except (ImportError, SyntaxError): # pragma: nocover
|
|
import json
|
|
|
|
|
|
log = logging.getLogger('WakaTime')
|
|
|
|
|
|
def get_file_stats(file_name, entity_type='file', lineno=None, cursorpos=None,
|
|
plugin=None, language=None, local_file=None):
|
|
"""Returns a hash of information about the entity."""
|
|
|
|
language = standardize_language(language, plugin)
|
|
stats = {
|
|
'language': language,
|
|
'dependencies': [],
|
|
'lines': None,
|
|
'lineno': lineno,
|
|
'cursorpos': cursorpos,
|
|
}
|
|
|
|
if entity_type == 'file':
|
|
lexer = get_lexer(language)
|
|
if not language:
|
|
language, lexer = guess_language(file_name, local_file)
|
|
parser = DependencyParser(local_file or file_name, lexer)
|
|
stats.update({
|
|
'language': use_root_language(language, lexer),
|
|
'dependencies': parser.parse(),
|
|
'lines': number_lines_in_file(local_file or file_name),
|
|
})
|
|
|
|
return stats
|
|
|
|
|
|
def guess_language(file_name, local_file):
|
|
"""Guess lexer and language for a file.
|
|
|
|
Returns a tuple of (language_str, lexer_obj).
|
|
"""
|
|
|
|
lexer = None
|
|
|
|
language = get_language_from_extension(file_name)
|
|
if language:
|
|
lexer = get_lexer(language)
|
|
else:
|
|
lexer = smart_guess_lexer(file_name, local_file)
|
|
if lexer:
|
|
language = u(lexer.name)
|
|
|
|
return language, lexer
|
|
|
|
|
|
def smart_guess_lexer(file_name, local_file):
|
|
"""Guess Pygments lexer for a file.
|
|
|
|
Looks for a vim modeline in file contents, then compares the accuracy
|
|
of that lexer with a second guess. The second guess looks up all lexers
|
|
matching the file name, then runs a text analysis for the best choice.
|
|
"""
|
|
lexer = None
|
|
|
|
text = get_file_head(file_name)
|
|
|
|
lexer1, accuracy1 = guess_lexer_using_filename(local_file or file_name, text)
|
|
lexer2, accuracy2 = guess_lexer_using_modeline(text)
|
|
|
|
if lexer1:
|
|
lexer = lexer1
|
|
if (lexer2 and accuracy2 and
|
|
(not accuracy1 or accuracy2 > accuracy1)):
|
|
lexer = lexer2
|
|
|
|
return lexer
|
|
|
|
|
|
def guess_lexer_using_filename(file_name, text):
|
|
"""Guess lexer for given text, limited to lexers for this file's extension.
|
|
|
|
Returns a tuple of (lexer, accuracy).
|
|
"""
|
|
|
|
lexer, accuracy = None, None
|
|
|
|
try:
|
|
lexer = custom_pygments_guess_lexer_for_filename(file_name, text)
|
|
except SkipHeartbeat as ex:
|
|
raise SkipHeartbeat(u(ex))
|
|
except:
|
|
log.traceback(logging.DEBUG)
|
|
|
|
if lexer is not None:
|
|
try:
|
|
accuracy = lexer.analyse_text(text)
|
|
except:
|
|
log.traceback(logging.DEBUG)
|
|
|
|
return lexer, accuracy
|
|
|
|
|
|
def guess_lexer_using_modeline(text):
|
|
"""Guess lexer for given text using Vim modeline.
|
|
|
|
Returns a tuple of (lexer, accuracy).
|
|
"""
|
|
|
|
lexer, accuracy = None, None
|
|
|
|
file_type = None
|
|
try:
|
|
file_type = get_filetype_from_buffer(text)
|
|
except: # pragma: nocover
|
|
log.traceback(logging.DEBUG)
|
|
|
|
if file_type is not None:
|
|
try:
|
|
lexer = get_lexer_by_name(file_type)
|
|
except ClassNotFound:
|
|
log.traceback(logging.DEBUG)
|
|
|
|
if lexer is not None:
|
|
try:
|
|
accuracy = lexer.analyse_text(text)
|
|
except: # pragma: nocover
|
|
log.traceback(logging.DEBUG)
|
|
|
|
return lexer, accuracy
|
|
|
|
|
|
def get_language_from_extension(file_name):
|
|
"""Returns a matching language for the given file extension.
|
|
|
|
When guessed_language is 'C', does not restrict to known file extensions.
|
|
"""
|
|
|
|
filepart, extension = os.path.splitext(file_name)
|
|
pathpart, filename = os.path.split(file_name)
|
|
|
|
if filename == 'go.mod':
|
|
return 'Go'
|
|
|
|
if re.match(r'\.h.*$', extension, re.IGNORECASE) or re.match(r'\.c.*$', extension, re.IGNORECASE):
|
|
|
|
if os.path.exists(u('{0}{1}').format(u(filepart), u('.c'))) or os.path.exists(u('{0}{1}').format(u(filepart), u('.C'))):
|
|
return 'C'
|
|
|
|
if os.path.exists(u('{0}{1}').format(u(filepart), u('.m'))) or os.path.exists(u('{0}{1}').format(u(filepart), u('.M'))):
|
|
return 'Objective-C'
|
|
|
|
if os.path.exists(u('{0}{1}').format(u(filepart), u('.mm'))) or os.path.exists(u('{0}{1}').format(u(filepart), u('.MM'))):
|
|
return 'Objective-C++'
|
|
|
|
available_extensions = extensions_in_same_folder(file_name)
|
|
|
|
for ext in CppLexer.filenames:
|
|
ext = ext.lstrip('*')
|
|
if ext in available_extensions:
|
|
return 'C++'
|
|
|
|
if '.c' in available_extensions:
|
|
return 'C'
|
|
|
|
if re.match(r'\.m$', extension, re.IGNORECASE) and (os.path.exists(u('{0}{1}').format(u(filepart), u('.h'))) or os.path.exists(u('{0}{1}').format(u(filepart), u('.H')))):
|
|
return 'Objective-C'
|
|
|
|
if re.match(r'\.mm$', extension, re.IGNORECASE) and (os.path.exists(u('{0}{1}').format(u(filepart), u('.h'))) or os.path.exists(u('{0}{1}').format(u(filepart), u('.H')))):
|
|
return 'Objective-C++'
|
|
|
|
return None
|
|
|
|
|
|
def number_lines_in_file(file_name):
|
|
try:
|
|
if os.path.getsize(file_name) > MAX_FILE_SIZE_SUPPORTED:
|
|
return None
|
|
except os.error:
|
|
pass
|
|
lines = 0
|
|
try:
|
|
with open(file_name, 'r', encoding='utf-8') as fh:
|
|
for line in fh:
|
|
lines += 1
|
|
except: # pragma: nocover
|
|
try:
|
|
with open(file_name, 'r', encoding=sys.getfilesystemencoding()) as fh:
|
|
for line in fh:
|
|
lines += 1
|
|
except:
|
|
return None
|
|
return lines
|
|
|
|
|
|
def standardize_language(language, plugin):
|
|
"""Maps a string to the equivalent Pygments language.
|
|
|
|
Returns the standardized language string.
|
|
"""
|
|
|
|
if not language:
|
|
return None
|
|
|
|
# standardize language for this plugin
|
|
if plugin:
|
|
plugin = plugin.split(' ')[-1].split('/')[0].split('-')[0]
|
|
standardized = get_language_from_json(language, plugin)
|
|
if standardized is not None:
|
|
return standardized
|
|
|
|
# standardize language against default languages
|
|
return get_language_from_json(language, 'default')
|
|
|
|
|
|
def get_lexer(language):
|
|
"""Return a Pygments Lexer object for the given language string."""
|
|
|
|
if not language:
|
|
return None
|
|
|
|
lexer_cls = find_lexer_class(language)
|
|
if lexer_cls:
|
|
return lexer_cls()
|
|
|
|
return None
|
|
|
|
|
|
def use_root_language(language, lexer):
|
|
if lexer and hasattr(lexer, 'root_lexer'):
|
|
return u(lexer.root_lexer.name)
|
|
|
|
return language
|
|
|
|
|
|
def get_language_from_json(language, key):
|
|
"""Finds the given language in a json file."""
|
|
|
|
file_name = os.path.join(
|
|
os.path.dirname(__file__),
|
|
'languages',
|
|
'{0}.json').format(key.lower())
|
|
|
|
if os.path.exists(file_name):
|
|
try:
|
|
with open(file_name, 'r', encoding='utf-8') as fh:
|
|
languages = json.loads(fh.read())
|
|
if languages.get(language.lower()):
|
|
return languages[language.lower()]
|
|
except:
|
|
log.traceback(logging.DEBUG)
|
|
|
|
return None
|
|
|
|
|
|
def get_file_head(file_name):
|
|
"""Returns the first 512000 bytes of the file's contents."""
|
|
|
|
text = None
|
|
try:
|
|
with open(file_name, 'r', encoding='utf-8') as fh:
|
|
text = fh.read(512000)
|
|
except:
|
|
try:
|
|
with open(file_name, 'r', encoding=sys.getfilesystemencoding()) as fh:
|
|
text = fh.read(512000) # pragma: nocover
|
|
except:
|
|
log.traceback(logging.DEBUG)
|
|
return text
|
|
|
|
|
|
def custom_pygments_guess_lexer_for_filename(_fn, _text, **options):
|
|
"""Overwrite pygments.lexers.guess_lexer_for_filename to customize the
|
|
priority of different lexers based on popularity of languages."""
|
|
|
|
fn = basename(_fn)
|
|
primary = {}
|
|
matching_lexers = set()
|
|
for lexer in _iter_lexerclasses():
|
|
for filename in lexer.filenames:
|
|
if _fn_matches(fn, filename):
|
|
matching_lexers.add(lexer)
|
|
primary[lexer] = True
|
|
for filename in lexer.alias_filenames:
|
|
if _fn_matches(fn, filename):
|
|
matching_lexers.add(lexer)
|
|
primary[lexer] = False
|
|
if not matching_lexers:
|
|
raise ClassNotFound('no lexer for filename %r found' % fn)
|
|
if len(matching_lexers) == 1:
|
|
return matching_lexers.pop()(**options)
|
|
result = []
|
|
for lexer in matching_lexers:
|
|
rv = lexer.analyse_text(_text)
|
|
if rv == 1.0:
|
|
return lexer(**options)
|
|
result.append(customize_lexer_priority(_fn, rv, lexer))
|
|
|
|
matlab = list(filter(lambda x: x[2].name.lower() == 'matlab', result))
|
|
if len(matlab) > 0:
|
|
objc = list(filter(lambda x: x[2].name.lower() == 'objective-c', result))
|
|
if objc and objc[0][0] == matlab[0][0]:
|
|
raise SkipHeartbeat('Skipping because not enough language accuracy.')
|
|
|
|
def type_sort(t):
|
|
# sort by:
|
|
# - analyse score
|
|
# - is primary filename pattern?
|
|
# - priority
|
|
# - last resort: class name
|
|
return (t[0], primary[t[2]], t[1], t[2].__name__)
|
|
result.sort(key=type_sort)
|
|
|
|
return result[-1][2](**options)
|
|
|
|
|
|
def customize_lexer_priority(file_name, accuracy, lexer):
|
|
"""Customize lexer priority"""
|
|
|
|
priority = lexer.priority
|
|
|
|
lexer_name = lexer.name.lower().replace('sharp', '#')
|
|
if lexer_name in LANGUAGES:
|
|
priority = LANGUAGES[lexer_name]
|
|
elif lexer_name == 'matlab':
|
|
available_extensions = extensions_in_same_folder(file_name)
|
|
if '.mat' in available_extensions:
|
|
accuracy += 0.01
|
|
if '.h' not in available_extensions:
|
|
accuracy += 0.01
|
|
elif lexer_name == 'objective-c':
|
|
available_extensions = extensions_in_same_folder(file_name)
|
|
if '.mat' in available_extensions:
|
|
accuracy -= 0.01
|
|
else:
|
|
accuracy += 0.01
|
|
if '.h' in available_extensions:
|
|
accuracy += 0.01
|
|
|
|
return (accuracy, priority, lexer)
|
|
|
|
|
|
def extensions_in_same_folder(file_name):
|
|
"""Returns a list of file extensions from the same folder as file_name."""
|
|
|
|
directory = os.path.dirname(file_name)
|
|
files = os.listdir(directory)
|
|
extensions = list(zip(*map(os.path.splitext, files)))[1]
|
|
extensions = set([ext.lower() for ext in extensions])
|
|
return extensions
|