File: __init__.py

package info (click to toggle)
django-sass 1.1.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 200 kB
  • sloc: python: 388; makefile: 4
file content (143 lines) | stat: -rw-r--r-- 4,622 bytes parent folder | download
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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
from typing import Dict, List
import os

from django.contrib.staticfiles.finders import get_finders
import sass


def find_static_paths() -> List[str]:
    """
    Finds all static paths available in this Django project.

    :returns:
        List of paths containing static files.
    """
    found_paths = []
    for finder in get_finders():
        if hasattr(finder, "storages"):
            for appname in finder.storages:
                if hasattr(finder.storages[appname], "location"):
                    abspath = finder.storages[appname].location
                    found_paths.append(abspath)
    return found_paths


def find_static_scss() -> List[str]:
    """
    Finds all static scss/sass files available in this Django project.

    :returns:
        List of paths of static scss/sass files.
    """
    scss_files = []
    for finder in get_finders():
        for path, storage in finder.list([]):
            if path.endswith(".scss") or path.endswith(".sass"):
                fullpath = finder.find(path)
                scss_files.append(fullpath)
    return scss_files


def compile_sass(
    inpath: str,
    outpath: str,
    output_style: str = None,
    precision: int = None,
    source_map: bool = False,
    include_paths: List[str] = None,
) -> None:
    """
    Calls sass.compile() within context of Django's known static file paths,
    and writes output CSS and/or sourcemaps to file.

    :param str inpath:
        Path to SCSS/Sass file or directory of SCSS/Sass files.
    :param str outpath:
        Path to a CSS file or directory in which to write output. The path will
        be created if it does not exist.
    :param str output_style:
        Corresponds to `output_style` from sass package.
    :param int precision:
        Corresponds to `precision` from sass package.
    :param bool source_map:
        If True, write a source map along with the output CSS file.
        Only valid when `inpath` is a file.
    :returns:
        None
    """

    # If include paths are not specified, use Django static paths
    include_paths = include_paths or find_static_paths()

    # Additional sass args that must be figured out.
    sassargs = {}  # type: Dict[str, object]

    # Handle input directories.
    if os.path.isdir(inpath):
        # Assume outpath is also a dir, or make it.
        if not os.path.exists(outpath):
            os.makedirs(outpath)
        if os.path.isdir(outpath):
            sassargs.update({"dirname": (inpath, outpath)})
        else:
            raise NotADirectoryError(
                "Output path must also be a directory when input path is a directory."
            )

    # Handle input files.
    outfile = None
    if os.path.isfile(inpath):

        sassargs.update({"filename": inpath})

        # If outpath does not exist, guess if it should be a dir and create it.
        if not os.path.exists(outpath):
            if not outpath.endswith(".css"):
                os.makedirs(outpath)

        # If outpath is a directory, create a child file.
        # Otherwise use provided file path.
        if os.path.exists(outpath) and os.path.isdir(outpath):
            outfile = os.path.join(
                outpath,
                os.path.basename(
                    inpath.replace(".scss", ".css").replace(".sass", ".css")
                ),
            )
        else:
            outfile = outpath

        # Create source map if specified.
        if source_map:
            sassargs.update({"source_map_filename": outfile + ".map"})

    # Compile the sass.
    rval = sass.compile(
        output_style=output_style,
        precision=precision,
        include_paths=include_paths,
        **sassargs,
    )

    # Write output.
    # sass.compile() will return None if used with dirname.
    # If used with filename, it will return a string of file contents.
    if rval and outfile:
        # If we got a css and sourcemap tuple, write the sourcemap.
        if isinstance(rval, tuple):
            map_outfile = outfile + ".map"
            outfile_dir = os.path.dirname(map_outfile)
            if not os.path.exists(outfile_dir):
                os.makedirs(outfile_dir, exist_ok=True)
            file = open(map_outfile, "w", encoding="utf8")
            file.write(rval[1])
            file.close()
            rval = rval[0]

        # Write the outputted css to file.
        outfile_dir = os.path.dirname(outfile)
        if not os.path.exists(outfile_dir):
            os.makedirs(outfile_dir, exist_ok=True)
        file = open(outfile, "w", encoding="utf8")
        file.write(rval)
        file.close()