/usr/lib/python2.7/dist-packages/sphinx_gallery/sorting.py is in python-sphinx-gallery 0.1.13-1ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 | # -*- coding: utf-8 -*-
r"""
Sorters for Sphinx-Gallery (sub)sections
========================================
Sorting key functions for gallery subsection folders and section files.
"""
# Created: Sun May 21 20:38:59 2017
# Author: Óscar Nájera
# License: 3-clause BSD
from __future__ import division, absolute_import, print_function
import os
import types
from .gen_rst import extract_intro_and_title
from .py_source_parser import split_code_and_text_blocks
class ExplicitOrder(object):
"""Sorting key for all gallery subsections.
This requires all folders to be listed otherwise an exception is raised.
Parameters
----------
ordered_list : list, tuple, types.GeneratorType
Hold the paths of each galleries' subsections.
Raises
------
ValueError
Wrong input type or Subgallery path missing.
"""
def __init__(self, ordered_list):
if not isinstance(ordered_list, (list, tuple, types.GeneratorType)):
raise ValueError("ExplicitOrder sorting key takes a list, "
"tuple or Generator, which hold"
"the paths of each gallery subfolder")
self.ordered_list = list(os.path.normpath(path)
for path in ordered_list)
def __call__(self, item):
if item in self.ordered_list:
return self.ordered_list.index(item)
else:
raise ValueError('If you use an explicit folder ordering, you '
'must specify all folders. Explicit order not '
'found for {}'.format(item))
class _SortKey(object):
"""Base class for section order key classes."""
def __init__(self, src_dir):
self.src_dir = src_dir
class NumberOfCodeLinesSortKey(_SortKey):
"""Sort examples in src_dir by the number of code lines.
Parameters
----------
src_dir : str
The source directory.
"""
def __call__(self, filename):
src_file = os.path.normpath(os.path.join(self.src_dir, filename))
file_conf, script_blocks = split_code_and_text_blocks(src_file)
amount_of_code = sum([len(bcontent)
for blabel, bcontent, lineno in script_blocks
if blabel == 'code'])
return amount_of_code
class FileSizeSortKey(_SortKey):
"""Sort examples in src_dir by file size.
Parameters
----------
src_dir : str
The source directory.
"""
def __call__(self, filename):
src_file = os.path.normpath(os.path.join(self.src_dir, filename))
return os.stat(src_file).st_size
class FileNameSortKey(_SortKey):
"""Sort examples in src_dir by file size.
Parameters
----------
src_dir : str
The source directory.
"""
def __call__(self, filename):
return filename
class ExampleTitleSortKey(_SortKey):
"""Sort examples in src_dir by example title.
Parameters
----------
src_dir : str
The source directory.
"""
def __call__(self, filename):
src_file = os.path.normpath(os.path.join(self.src_dir, filename))
_, script_blocks = split_code_and_text_blocks(src_file)
_, title = extract_intro_and_title(src_file, script_blocks[0][1])
return title
|