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 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265
|
# Copyright 2018 The pybadge Authors
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Creates a github-style badge as a SVG image.
This package seeks to generate semantically-identical output to the JavaScript
gh-badges library
(https://github.com/badges/shields/blob/master/doc/gh-badges.md)
>>> badge(left_text='coverage', right_text='23%', right_color='red')
'<svg...</svg>'
>>> badge(left_text='build', right_text='green', right_color='green',
... whole_link="http://www.example.com/")
'<svg...</svg>'
>>> # base64-encoded PNG image
>>> image_data = 'iVBORw0KGgoAAAANSUhEUgAAAAIAAAACCAIAAAD91JpzAAAAD0lEQVQI12P4zwAD/xkYAA/+Af8iHnLUAAAAAElFTkSuQmCC'
>>> badge(left_text='build', right_text='green', right_color='green',
... logo="data:image/png;base64," + image_data)
'<svg...</svg>'
"""
import base64
import mimetypes
from typing import Optional
import urllib.parse
from xml.dom import minidom
import jinja2
import requests
from pybadges import text_measurer
from pybadges import precalculated_text_measurer
from pybadges.version import __version__
_JINJA2_ENVIRONMENT = jinja2.Environment(
trim_blocks=True,
lstrip_blocks=True,
loader=jinja2.PackageLoader('pybadges', '.'),
autoescape=jinja2.select_autoescape(['svg']))
# Use the same color scheme as describe in:
# https://github.com/badges/shields/blob/master/lib/colorscheme.json
_NAME_TO_COLOR = {
'brightgreen': '#4c1',
'green': '#97CA00',
'yellow': '#dfb317',
'yellowgreen': '#a4a61d',
'orange': '#fe7d37',
'red': '#e05d44',
'blue': '#007ec6',
'grey': '#555',
'gray': '#555',
'lightgrey': '#9f9f9f',
'lightgray': '#9f9f9f',
'critical': '#e05d44',
'important': '#fe7d37',
'success': '#4c1',
'informational': '#007ec6',
'inactive': '#9f9f9f',
}
def imghdr_what(data: bytes) -> Optional[str]:
"""Replacement for the deprecated imghdr module"""
if len(data) <= 32:
return None
header = data[0:32]
if header[6:10] in (b'JFIF', b'Exif'):
return 'jpeg'
elif header[:4] == b'\xff\xd8\xff\xdb':
return 'jpeg'
elif header.startswith(b'\211PNG\r\n\032\n'):
return 'png'
elif header[:6] in (b'GIF87a', b'GIF89a'):
return 'gif'
else:
return None
def _remove_blanks(node):
for x in node.childNodes:
if x.nodeType == minidom.Node.TEXT_NODE:
if x.nodeValue:
x.nodeValue = x.nodeValue.strip()
elif x.nodeType == minidom.Node.ELEMENT_NODE:
_remove_blanks(x)
def _embed_image(url: str) -> str:
parsed_url = urllib.parse.urlparse(url)
if parsed_url.scheme == 'data':
return url
elif parsed_url.scheme.startswith('http'):
r = requests.get(url)
r.raise_for_status()
content_type = r.headers.get('content-type')
if content_type is None:
raise ValueError('no "Content-Type" header')
content_type, image_type = content_type.split('/')
if content_type != 'image':
raise ValueError(
'expected an image, got "{0}"'.format(content_type))
image_data = r.content
elif parsed_url.scheme:
raise ValueError('unsupported scheme "{0}"'.format(parsed_url.scheme))
else:
with open(url, 'rb') as f:
image_data = f.read()
image_type = imghdr_what(image_data)
if not image_type:
mime_type, _ = mimetypes.guess_type(url, strict=False)
if not mime_type:
raise ValueError('not able to determine file type')
else:
content_type, image_type = mime_type.split('/')
if content_type != 'image':
raise ValueError('expected an image, got "{0}"'.format(
content_type or 'unknown'))
encoded_image = base64.b64encode(image_data).decode('ascii')
return 'data:image/{};base64,{}'.format(image_type, encoded_image)
def badge(
left_text: str,
right_text: Optional[str] = None,
left_link: Optional[str] = None,
right_link: Optional[str] = None,
center_link: Optional[str] = None,
whole_link: Optional[str] = None,
logo: Optional[str] = None,
left_color: str = '#555',
right_color: str = '#007ec6',
center_color: Optional[str] = None,
measurer: Optional[text_measurer.TextMeasurer] = None,
left_title: Optional[str] = None,
right_title: Optional[str] = None,
center_title: Optional[str] = None,
whole_title: Optional[str] = None,
right_image: Optional[str] = None,
center_image: Optional[str] = None,
embed_logo: bool = False,
embed_right_image: bool = False,
embed_center_image: bool = False,
id_suffix: str = '',
) -> str:
"""Creates a github-style badge as an SVG image.
>>> badge(left_text='coverage', right_text='23%', right_color='red')
'<svg...</svg>'
>>> badge(left_text='build', right_text='green', right_color='green',
... whole_link="http://www.example.com/")
'<svg...</svg>'
Args:
left_text: The text that should appear on the left-hand-side of the
badge e.g. "coverage".
right_text: The text that should appear on the right-hand-side of the
badge e.g. "23%".
left_link: The URL that should be redirected to when the left-hand text
is selected.
right_link: The URL that should be redirected to when the right-hand
text is selected.
whole_link: The link that should be redirected to when the badge is
selected. If set then left_link and right_right may not be set.
logo: A url representing a logo that will be displayed inside the
badge. Can be a data URL e.g. "data:image/svg+xml;utf8,<svg..."
left_color: The color of the part of the badge containing the left-hand
text. Can be an valid CSS color
(see https://developer.mozilla.org/en-US/docs/Web/CSS/color) or a
color name defined here:
https://github.com/badges/shields/blob/master/badge-maker/lib/color.js
right_color: The color of the part of the badge containing the
right-hand text. Can be an valid CSS color
(see https://developer.mozilla.org/en-US/docs/Web/CSS/color) or a
color name defined here:
https://github.com/badges/shields/blob/master/badge-maker/lib/color.js
measurer: A text_measurer.TextMeasurer that can be used to measure the
width of left_text and right_text.
embed_logo: If True then embed the logo image directly in the badge.
This can prevent an HTTP request and some browsers will not render
external image referenced. When True, `logo` must be a HTTP/HTTPS
URI or a filesystem path. Also, the `badge` call may raise an
exception if the logo cannot be loaded, is not an image, etc.
whole_title: The title attribute to associate with the entire badge.
See https://developer.mozilla.org/en-US/docs/Web/SVG/Element/title.
left_title: The title attribute to associate with the left part of the
badge.
See https://developer.mozilla.org/en-US/docs/Web/SVG/Element/title.
right_title: The title attribute to associate with the right part of
the badge.
See https://developer.mozilla.org/en-US/docs/Web/SVG/Element/title.
id_suffix: The suffix of the id attributes used in the SVG's elements.
Use to prevent duplicate ids if several badges are embedded on the
same page.
"""
if measurer is None:
measurer = (
precalculated_text_measurer.PrecalculatedTextMeasurer.default())
if (left_link or right_link or center_link) and whole_link:
raise ValueError(
'whole_link may not bet set with left_link, right_link, or center_link'
)
if center_image and not (right_image or right_text):
raise ValueError('cannot have a center_image without a right element')
if (center_image and not center_color) or (not center_image and
center_color):
raise ValueError('must have both a center_image and a center_color')
if logo and embed_logo:
logo = _embed_image(logo)
if right_image and embed_right_image:
right_image = _embed_image(right_image)
if center_image and embed_center_image:
center_image = _embed_image(center_image)
if center_color:
center_color = _NAME_TO_COLOR.get(center_color, center_color)
right_text_width = None
if right_text:
right_text_width = measurer.text_width(right_text) / 10.0
template = _JINJA2_ENVIRONMENT.get_template('badge-template-full.svg')
svg = template.render(
left_text=left_text,
right_text=right_text,
left_text_width=measurer.text_width(left_text) / 10.0,
right_text_width=right_text_width,
left_link=left_link,
right_link=right_link,
whole_link=whole_link,
center_link=center_link,
logo=logo,
left_color=_NAME_TO_COLOR.get(left_color, left_color),
right_color=_NAME_TO_COLOR.get(right_color, right_color),
center_color=center_color,
left_title=left_title,
right_title=right_title,
center_title=center_title,
whole_title=whole_title,
right_image=right_image,
center_image=center_image,
id_suffix=id_suffix,
)
xml = minidom.parseString(svg)
_remove_blanks(xml)
xml.normalize()
return xml.documentElement.toxml()
|