/usr/lib/python3/dist-packages/pyfits/header.py is in python3-pyfits 1:3.2-1build2.
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 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 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 | import copy
import inspect
import itertools
import re
import sys
import warnings
from collections import defaultdict
from pyfits.card import Card, CardList, BLANK_CARD, KEYWORD_LENGTH, _pad
from pyfits.file import _File
from pyfits.util import (BLOCK_SIZE, deprecated, isiterable, encode_ascii,
decode_ascii, fileobj_is_binary, fileobj_closed,
_pad_length)
PY3K = sys.version_info[:2] >= (3, 0)
HEADER_END_RE = re.compile(encode_ascii('END {77} *'))
# According to the FITS standard the only characters that may appear in a
# header record are the restricted ASCII chars from 0x20 through 0x7E.
VALID_HEADER_CHARS = set(chr(x) for x in range(0x20, 0x7F))
class Header(object):
"""
FITS header class. This class exposes both a dict-like interface and a
list-like interface to FITS headers.
The header may be indexed by keyword and, like a dict, the associated value
will be returned. When the header contains cards with duplicate keywords,
only the value of the first card with the given keyword will be returned.
It is also possible to use a 2-tuple as the index in the form (keyword,
n)--this returns the n-th value with that keyword, in the case where there
are duplicate keywords.
For example:
>>> header['NAXIS']
0
>>> header[('FOO', 1)] # Return the value of the second FOO keyword
'foo'
The header may also be indexed by card number:
>>> header[0] # Return the value of the first card in the header
'T'
Commentary keywords such as HISTORY and COMMENT are special cases: When
indexing the Header object with either 'HISTORY' or 'COMMENT' a list of all
the HISTORY/COMMENT values is returned:
>>> header['HISTORY']
This is the first history entry in this header.
This is the second history entry in this header.
...
See the PyFITS documentation for more details on working with headers.
"""
def __init__(self, cards=[], txtfile=None):
"""
Construct a `Header` from an iterable and/or text file.
Parameters
----------
cards : A list of `Card` objects (optional)
The cards to initialize the header with.
txtfile : file path, file object or file-like object (optional)
Input ASCII header parameters file **(Deprecated)**
Use the Header.fromfile classmethod instead.
"""
self.clear()
if txtfile:
warnings.warn(
'The txtfile argument is deprecated. Use Header.fromfile to '
'create a new Header object from a text file.',
DeprecationWarning)
# get the cards from the input ASCII file
self.update(self.fromfile(txtfile))
self._modified = False
return
if isinstance(cards, Header):
cards = cards.cards
for card in cards:
self.append(card, end=True)
self._modified = False
def __len__(self):
return len(self._cards)
def __iter__(self):
for card in self._cards:
yield card.keyword
def __contains__(self, keyword):
try:
self._cardindex(keyword)
except (KeyError, IndexError):
return False
return True
def __getitem__(self, key):
if isinstance(key, slice):
return Header([copy.copy(c) for c in self._cards[key]])
elif self._haswildcard(key):
return Header([copy.copy(self._cards[idx])
for idx in self._wildcardmatch(key)])
elif (isinstance(key, str) and
key.upper() in Card._commentary_keywords):
key = key.upper()
# Special case for commentary cards
return _HeaderCommentaryCards(self, key)
if isinstance(key, tuple):
keyword = key[0]
else:
keyword = key
card = self._cards[self._cardindex(key)]
if (card.field_specifier is not None and
keyword == card.keyword.split('.', 1)[0]):
# This is RVKC; if only the top-level keyword was specified return
# the raw value, not the parsed out float value
return card.rawvalue
return card.value
def __setitem__(self, key, value):
if isinstance(key, slice) or self._haswildcard(key):
if isinstance(key, slice):
indices = range(*key.indices(len(self)))
else:
indices = self._wildcardmatch(key)
if isinstance(value, str) or not isiterable(value):
value = itertools.repeat(value, len(indices))
for idx, val in zip(indices, value):
self[idx] = val
return
if isinstance(value, tuple):
if not (0 < len(value) <= 2):
raise ValueError(
'A Header item may be set with either a scalar value, '
'a 1-tuple containing a scalar value, or a 2-tuple '
'containing a scalar value and comment string.')
if len(value) == 1:
value, comment = value[0], None
if value is None:
value = ''
elif len(value) == 2:
value, comment = value
if value is None:
value = ''
if comment is None:
comment = ''
else:
comment = None
card = None
if isinstance(key, int):
card = self._cards[key]
elif isinstance(key, tuple):
card = self._cards[self._cardindex(key)]
if card:
card.value = value
if comment is not None:
card.comment = comment
if card._modified:
self._modified = True
else:
# If we get an IndexError that should be raised; we don't allow
# assignment to non-existing indices
self._update((key, value, comment))
def __delitem__(self, key):
if isinstance(key, slice) or self._haswildcard(key):
# This is very inefficient but it's not a commonly used feature.
# If someone out there complains that they make heavy use of slice
# deletions and it's too slow, well, we can worry about it then
# [the solution is not too complicated--it would be wait 'til all
# the cards are deleted before updating _keyword_indices rather
# than updating it once for each card that gets deleted]
if isinstance(key, slice):
indices = range(*key.indices(len(self)))
# If the slice step is backwards we want to reverse it, because
# it will be reversed in a few lines...
if key.step and key.step < 0:
indices = reversed(indices)
else:
indices = self._wildcardmatch(key)
for idx in reversed(indices):
del self[idx]
return
elif isinstance(key, str):
# delete ALL cards with the same keyword name
key = Card.normalize_keyword(key)
if key not in self._keyword_indices:
if _is_pyfits_internal():
# All internal code is designed to assume that this will
# raise a KeyError, so go ahead and do so
raise KeyError("Keyword '%s' not found." % key)
# Warn everyone else.
# TODO: Remove this warning and make KeyError the default after
# a couple versions (by 3.3, say)
warnings.warn(
'Deletion of non-existent keyword %r: '
'In a future PyFITS version Header.__delitem__ may be '
'changed so that this raises a KeyError just like a dict '
'would. Please update your code so that KeyErrors are '
'caught and handled when deleting non-existent keywords.' %
key, DeprecationWarning)
return
for idx in reversed(self._keyword_indices[key]):
# Have to copy the indices list since it will be modified below
del self[idx]
return
idx = self._cardindex(key)
keyword = self._cards[idx].keyword
del self._cards[idx]
indices = self._keyword_indices[keyword]
indices.remove(idx)
if not indices:
del self._keyword_indices[keyword]
# We also need to update all other indices
self._updateindices(idx, increment=False)
self._modified = True
def __repr__(self):
return self.tostring(sep='\n', endcard=False, padding=False)
def __str__(self):
return self.tostring()
def __eq__(self, other):
"""
Two Headers are equal only if they have the exact same string
representation.
"""
return str(self) == str(other)
def __add__(self, other):
temp = self.copy(strip=False)
temp.extend(other)
return temp
def __iadd__(self, other):
self.extend(other)
return self
@property
def cards(self):
"""
The underlying physical cards that make up this Header; it can be
looked at, but it should not be modified directly.
"""
return _CardAccessor(self)
@property
def comments(self):
"""
View the comments associated with each keyword, if any.
For example, to see the comment on the NAXIS keyword:
>>> header.comments['NAXIS']
number of data axes
Comments can also be updated through this interface:
>>> header.comments['NAXIS'] = 'Number of data axes'
"""
return _HeaderComments(self)
@property
def _modified(self):
"""
Whether or not the header has been modified; this is a property so that
it can also check each card for modifications--cards may have been
modified directly without the header containing it otherwise knowing.
"""
modified_cards = any(c._modified for c in self._cards)
if modified_cards:
# If any cards were modified then by definition the header was
# modified
self.__dict__['_modified'] = True
return self.__dict__['_modified']
@_modified.setter
def _modified(self, val):
self.__dict__['_modified'] = val
@classmethod
def fromstring(cls, data, sep=''):
"""
Creates an HDU header from a byte string containing the entire header
data.
Parameters
----------
data : str
String containing the entire header.
sep : str (optional)
The string separating cards from each other, such as a newline. By
default there is no card separator (as is the case in a raw FITS
file).
Returns
-------
header
A new `Header` instance.
"""
cards = []
end = 'END' + ' ' * 77
# If the card separator contains characters that may validly appear in
# a card, the only way to unambiguously distinguish between cards is to
# require that they be Card.length long. However, if the separator
# contains non-valid characters (namely \n) the cards may be split
# immediately at the separator
require_full_cardlength = set(sep).issubset(VALID_HEADER_CHARS)
# Split the header into individual cards
idx = 0
image = []
while idx < len(data):
if require_full_cardlength:
end_idx = idx + Card.length
else:
try:
end_idx = data.index(sep, idx)
except ValueError:
end_idx = len(data)
next_image = data[idx:end_idx]
idx = end_idx + len(sep)
if image:
if next_image[:8] == 'CONTINUE':
image.append(next_image)
continue
cards.append(Card.fromstring(''.join(image)))
if require_full_cardlength:
if next_image == end:
image = []
break
else:
if next_image.split(sep)[0].rstrip() == 'END':
image = []
break
image = [next_image]
# Add the last image that was found before the end, if any
if image:
cards.append(Card.fromstring(''.join(image)))
return cls(cards)
@classmethod
def fromfile(cls, fileobj, sep='', endcard=True, padding=True):
"""
Similar to :meth:`Header.fromstring`, but reads the header string from
a given file-like object or filename.
Parameters
----------
fileobj : str, file-like
A filename or an open file-like object from which a FITS header is
to be read. For open file handles the file pointer must be at the
beginning of the header.
sep : str (optional)
The string separating cards from each other, such as a newline. By
default there is no card separator (as is the case in a raw FITS
file).
endcard : bool (optional)
If True (the default) the header must end with an END card in order
to be considered valid. If an END card is not found an `IOError`
is raised.
padding : bool (optional)
If True (the default) the header will be required to be padded out
to a multiple of 2880, the FITS header block size. Otherwise any
padding, or lack thereof, is ignored.
Returns
-------
header
A new `Header` instance.
"""
close_file = False
if isinstance(fileobj, str):
# Open in text mode by default to support newline handling; if a
# binary-mode file object is passed in, the user is on their own
# with respect to newline handling
fileobj = open(fileobj, 'r')
close_file = True
is_binary = fileobj_is_binary(fileobj)
actual_block_size = _block_size(sep)
clen = Card.length + len(sep)
try:
# Read the first header block.
block = fileobj.read(actual_block_size)
if not is_binary:
block = encode_ascii(block)
if not block:
raise EOFError()
blocks = []
is_eof = False
# continue reading header blocks until END card is reached
while True:
# find the END card
is_end = False
for mo in HEADER_END_RE.finditer(block):
# Ensure the END card was found, and it started on the
# boundary of a new card (see ticket #142)
if mo.start() % clen == 0:
# This must be the last header block, otherwise the
# file is malformatted
is_end = True
break
if not is_end:
blocks.append(decode_ascii(block))
block = fileobj.read(actual_block_size)
if not is_binary:
block = encode_ascii(block)
if not block:
is_eof = True
break
else:
break
last_block = block
blocks.append(decode_ascii(block))
blocks = ''.join(blocks)
# Strip any zero-padding (see ticket #106)
if blocks and blocks[-1] == '\0':
if is_eof and blocks.strip('\0') == '':
warnings.warn('Unexpected extra padding at the end of the '
'file. This padding may not be preserved '
'when saving changes.')
raise EOFError()
else:
# Replace the illegal null bytes with spaces as required by
# the FITS standard, and issue a nasty warning
warnings.warn('Header block contains null bytes instead '
'of spaces for padding, and is not FITS-'
'compliant. Nulls may be replaced with '
'spaces upon writing.')
blocks.replace('\0', ' ')
if not HEADER_END_RE.search(last_block) and endcard:
raise IOError('Header missing END card.')
if padding and (len(blocks) % actual_block_size) != 0:
# This error message ignores the length of the separator for
# now, but maybe it shouldn't?
actual_len = len(blocks) - actual_block_size + BLOCK_SIZE
raise ValueError('Header size is not multiple of %d: %d'
% (BLOCK_SIZE, actual_len))
return cls.fromstring(blocks, sep=sep)
finally:
if close_file:
fileobj.close()
def tostring(self, sep='', endcard=True, padding=True):
r"""
Returns a string representation of the header.
By default this uses no separator between cards, adds the END card, and
pads the string with spaces to the next multiple of 2880 bytes. That
is, it returns the header exactly as it would appear in a FITS file.
Parameters
----------
sep : str (optional)
The character or string with which to separate cards. By default
there is no separator, but one could use `'\\n'`, for example, to
separate each card with a new line
endcard : bool (optional)
If True (default) adds the END card to the end of the header
string
padding : bool (optional)
If True (default) pads the string with spaces out to the next
multiple of 2880 characters
Returns
-------
s : string
A string representing a FITS header.
"""
lines = []
for card in self._cards:
s = str(card)
# Cards with CONTINUE cards may be longer than 80 chars; so break
# them into multiple lines
while s:
lines.append(s[:Card.length])
s = s[Card.length:]
s = sep.join(lines)
if endcard:
s += sep + _pad('END')
if padding:
s += ' ' * _pad_length(len(s))
return s
def tofile(self, fileobj, sep='', endcard=True, padding=True,
clobber=False):
r"""
Writes the header to file or file-like object.
By default this writes the header exactly as it would be written to a
FITS file, with the END card included and padding to the next multiple
of 2880 bytes. However, aspects of this may be controlled.
Parameters
----------
fileobj : str, file (optional)
Either the pathname of a file, or an open file handle or file-like
object
sep : str (optional)
The character or string with which to separate cards. By default
there is no separator, but one could use `'\\n'`, for example, to
separate each card with a new line
endcard : bool (optional)
If `True` (default) adds the END card to the end of the header
string
padding : bool (optional)
If `True` (default) pads the string with spaces out to the next
multiple of 2880 characters
clobber : bool (optional)
If `True`, overwrites the output file if it already exists
"""
close_file = fileobj_closed(fileobj)
if not isinstance(fileobj, _File):
fileobj = _File(fileobj, mode='ostream', clobber=clobber)
try:
blocks = self.tostring(sep=sep, endcard=endcard, padding=padding)
actual_block_size = _block_size(sep)
if padding and len(blocks) % actual_block_size != 0:
raise IOError('Header size (%d) is not a multiple of block '
'size (%d).' %
(len(blocks) - actual_block_size + BLOCK_SIZE,
BLOCK_SIZE))
if not fileobj.simulateonly:
fileobj.flush()
try:
offset = fileobj.tell()
except (AttributeError, IOError):
offset = 0
fileobj.write(blocks.encode('ascii'))
fileobj.flush()
finally:
if close_file:
fileobj.close()
@classmethod
def fromtextfile(cls, fileobj, endcard=False):
"""
Equivalent to ``Header.fromfile(fileobj, sep='\\n', endcard=False,
padding=False)``.
"""
return cls.fromfile(fileobj, sep='\n', endcard=endcard, padding=False)
def totextfile(self, fileobj, endcard=False, clobber=False):
"""
Equivalent to ``Header.tofile(fileobj, sep='\\n', endcard=False,
padding=False, clobber=clobber)``.
"""
self.tofile(fileobj, sep='\n', endcard=endcard, padding=False,
clobber=clobber)
def clear(self):
"""
Remove all cards from the header.
"""
self._cards = []
self._keyword_indices = defaultdict(list)
def copy(self, strip=False):
"""
Make a copy of the :class:`Header`.
Parameters
----------
strip : bool (optional)
If True, strip any headers that are specific to one of the standard
HDU types, so that this header can be used in a different HDU.
Returns
-------
header
A new :class:`Header` instance.
"""
tmp = Header([copy.copy(card) for card in self._cards])
if strip:
tmp._strip()
return tmp
@classmethod
def fromkeys(cls, iterable, value=None):
"""
Similar to :meth:`dict.fromkeys`--creates a new `Header` from an
iterable of keywords and an optional default value.
This method is not likely to be particularly useful for creating real
world FITS headers, but it is useful for testing.
Parameters
----------
iterable
Any iterable that returns strings representing FITS keywords.
value : (optional)
A default value to assign to each keyword; must be a valid type for
FITS keywords.
Returns
-------
header
A new `Header` instance.
"""
d = cls()
if not isinstance(value, tuple):
value = (value,)
for key in iterable:
d.append((key,) + value)
return d
def get(self, key, default=None):
"""
Similar to :meth:`dict.get`--returns the value associated with keyword
in the header, or a default value if the keyword is not found.
Parameters
----------
key : str
A keyword that may or may not be in the header.
default : (optional)
A default value to return if the keyword is not found in the
header.
Returns
-------
value
The value associated with the given keyword, or the default value
if the keyword is not in the header.
"""
try:
return self[key]
except (KeyError, IndexError):
return default
def set(self, keyword, value=None, comment=None, before=None, after=None):
"""
Set the value and/or comment and/or position of a specified keyword.
If the keyword does not already exist in the header, a new keyword is
created in the specified position, or appended to the end of the header
if no position is specified.
This method is similar to :meth:`Header.update` prior to PyFITS 3.1.
.. note::
It should be noted that ``header.set(keyword, value)`` and
``header.set(keyword, value, comment)`` are equivalent to
``header[keyword] = value`` and
``header[keyword] = (value, comment)`` respectfully.
New keywords can also be inserted relative to existing keywords
using, for example
``header.insert('NAXIS1', ('NAXIS', 2, 'Number of axes'))`` to
insert before an existing keyword, or
``header.insert('NAXIS', ('NAXIS1', 4096), after=True)`` to insert
after an existing keyword.
The the only advantage of using :meth:`Header.set` is that it
easily replaces the old usage of :meth:`Header.update` both
conceptually and in terms of function signature.
Parameters
----------
keyword : str
A header keyword
value : str (optional)
The value to set for the given keyword; if None the existing value
is kept, but '' may be used to set a blank value
comment : str (optional)
The comment to set for the given keyword; if None the existing
comment is kept, but '' may be used to set a blank comment
before : str, int (optional)
Name of the keyword, or index of the `Card` before which
this card should be located in the header. The argument `before`
takes precedence over `after` if both specified.
after : str, int (optional)
Name of the keyword, or index of the `Card` after which this card
should be located in the header.
"""
# Create a temporary card that looks like the one being set; if the
# temporary card turns out to be a RVKC this will make it easier to
# deal with the idiosyncrasies thereof
# Don't try to make a temporary card though if they keyword looks like
# it might be a HIERARCH card or is otherwise invalid--this step is
# only for validating RVKCs.
if (len(keyword) <= KEYWORD_LENGTH and
Card._keywd_FSC_RE.match(keyword) and
keyword not in self._keyword_indices):
new_card = Card(keyword, value, comment)
new_keyword = new_card.keyword
else:
new_keyword = keyword
if (new_keyword not in Card._commentary_keywords and
new_keyword in self):
if comment is None:
comment = self.comments[keyword]
if value is None:
value = self[keyword]
self[keyword] = (value, comment)
if before is not None or after is not None:
card = self._cards[self._cardindex(keyword)]
self._relativeinsert(card, before=before, after=after,
replace=True)
elif before is not None or after is not None:
self._relativeinsert((keyword, value, comment), before=before,
after=after)
else:
self[keyword] = (value, comment)
def items(self):
"""Like :meth:`dict.items`."""
return list(self.items())
def iteritems(self):
"""Like :meth:`dict.iteritems`."""
for card in self._cards:
yield (card.keyword, card.value)
def iterkeys(self):
"""
Like :meth:`dict.iterkeys`--iterating directly over the `Header`
instance has the same behavior.
"""
return self.__iter__()
def itervalues(self):
"""Like :meth:`dict.itervalues`."""
for _, v in self.items():
yield v
def keys(self):
"""
Return a list of keywords in the header in the order they
appear--like:meth:`dict.keys` but ordered.
"""
return [keyword for keyword in self]
def pop(self, *args):
"""
Works like :meth:`list.pop` if no arguments or an index argument are
supplied; otherwise works like :meth:`dict.pop`.
"""
if len(args) > 2:
raise TypeError('Header.pop expected at most 2 arguments, got '
'%d' % len(args))
if len(args) == 0:
key = -1
else:
key = args[0]
try:
value = self[key]
except (KeyError, IndexError):
if len(args) == 2:
return args[1]
raise
del self[key]
return value
def popitem(self):
try:
k, v = next(iter(self.items()))
except StopIteration:
raise KeyError('Header is empty')
del self[k]
return k, v
def setdefault(self, key, default=None):
try:
return self[key]
except (KeyError, IndexError):
self[key] = default
return default
def update(self, *args, **kwargs):
"""
Update the Header with new keyword values, updating the values of
existing keywords and appending new keywords otherwise; similar to
dict.update().
update() accepts either a dict-like object or an iterable. In the
former case the keys must be header keywords and the values may be
either scalar values or (value, comment) tuples. In the case of an
iterable the items must be (keyword, value) tuples or
(keyword, value, comment) tuples.
Arbitrary arguments are also accepted, in which case the update() is
called again with the kwargs dict as its only argument. That is,
>>> header.update(NAXIS1=100, NAXIS2=100)
is equivalent to
>>> header.update({'NAXIS1': 100, 'NAXIS2': 100})
.. warning::
As this method works similarly to dict.update() it is very
different from the Header.update() method in PyFITS versions prior
to 3.1.0. However, support for the old API is also maintained for
backwards compatibility. If update() is called with at least two
positional arguments then it can be assumed that the old API is
being used. Use of the old API should be considered
**deprecated**. Most uses of the old API can be replaced as
follows:
* Replace
>>> header.update(keyword, value)
with
>>> header[keyword] = value
* Replace
>>> header.update(keyword, value, comment=comment)
with
>>> header[keyword] = (value, comment)
* Replace
>>> header.update(keyword, value, before=before_keyword)
with
>>> header.insert(before_keyword, (keyword, value))
* Replace
>>> header.update(keyword, value, after=after_keyword)
with
>>> header.insert(after_keyword, (keyword, value),
... after=True)
See also :meth:`Header.set` which is a new method that provides an
interface similar to the old Header.update() and may help make
transition a little easier.
For reference, the old documentation for the old Header.update()
is provided below:
Update one header card.
If the keyword already exists, it's value and/or comment will
be updated. If it does not exist, a new card will be created
and it will be placed before or after the specified location.
If no `before` or `after` is specified, it will be appended at
the end.
Parameters
----------
key : str
keyword
value : str
value to be used for updating
comment : str (optional)
to be used for updating, default=None.
before : str, int (optional)
name of the keyword, or index of the `Card` before which
the new card will be placed. The argument `before` takes
precedence over `after` if both specified.
after : str, int (optional)
name of the keyword, or index of the `Card` after which
the new card will be placed.
savecomment : bool (optional)
When `True`, preserve the current comment for an existing
keyword. The argument `savecomment` takes precedence over
`comment` if both specified. If `comment` is not
specified then the current comment will automatically be
preserved.
"""
legacy_args = ['key', 'value', 'comment', 'before', 'after',
'savecomment']
# This if statement covers all the cases in which this could be a
# legacy update(); note that it means it's impossible to do a
# dict-style update where *all* the keywords happen to legacy
# arguments, but realistically speaking that use case will not come up
# The fact that Python is "flexible" in allowing positional args to be
# passed in as keyword args makes this a little more complicated than
# it otherwise would be :/
issubset = set(kwargs).issubset(set(legacy_args))
if (len(args) >= 2 or
(len(args) == 1 and 'value' in kwargs and issubset) or
(len(args) == 0 and 'key' in kwargs and 'value' in kwargs and
issubset)):
# This must be a legacy update()
warnings.warn(
"The use of header.update() to add new keywords to a header "
"is deprecated. Instead, use either header.set() or simply "
"`header[keyword] = value` or "
"`header[keyword] = (value, comment)`. header.set() is only "
"necessary to use if you also want to use the before/after "
"keyword arguments.", DeprecationWarning)
for k, v in zip(legacy_args, args):
if k in kwargs:
raise TypeError(
'%s.update() got multiple values for keyword '
'argument %r' % (self.__class__.__name__, k))
kwargs[k] = v
keyword = kwargs.get('key')
value = kwargs.get('value')
comment = kwargs.get('comment')
before = kwargs.get('before')
after = kwargs.get('after')
savecomment = kwargs.get('savecomment')
# Handle the savecomment argument which is not currently used by
# Header.set()
if keyword in self and savecomment:
comment = None
self.set(keyword, value, comment, before, after)
else:
# The rest of this should work similarly to dict.update()
if args:
other = args[0]
else:
other = None
def update_from_dict(k, v):
if not isinstance(v, tuple):
card = Card(k, v)
elif 0 < len(v) <= 2:
card = Card(*((k,) + v))
else:
raise ValueError(
'Header update value for key %r is invalid; the '
'value must be either a scalar, a 1-tuple '
'containing the scalar value, or a 2-tuple '
'containing the value and a comment string.' % k)
self._update(card)
if other is None:
pass
elif hasattr(other, 'iteritems'):
for k, v in other.items():
update_from_dict(k, v)
elif hasattr(other, 'keys'):
for k in list(other.keys()):
update_from_dict(k, other[k])
else:
for idx, card in enumerate(other):
if isinstance(card, Card):
self._update(card)
elif isinstance(card, tuple) and (1 < len(card) <= 3):
self._update(Card(*card))
else:
raise ValueError(
'Header update sequence item #%d is invalid; '
'the item must either be a 2-tuple containing '
'a keyword and value, or a 3-tuple containing '
'a keyword, value, and comment string.' % idx)
if kwargs:
self.update(kwargs)
def values(self):
"""Returns a list of the values of all cards in the header."""
return [v for _, v in self.items()]
def append(self, card=None, useblanks=True, bottom=False, end=False):
"""
Appends a new keyword+value card to the end of the Header, similar
to list.append().
By default if the last cards in the Header have commentary keywords,
this will append the new keyword before the commentary (unless the new
keyword is also commentary).
Also differs from list.append() in that it can be called with no
arguments: In this case a blank card is appended to the end of the
Header. In the case all the keyword arguments are ignored.
Parameters
----------
card : str, tuple
A keyword or a (keyword, value, [comment]) tuple representing a
single header card; the comment is optional in which case a
2-tuple may be used
useblanks : bool (optional)
If there are blank cards at the end of the Header, replace the
first blank card so that the total number of cards in the Header
does not increase. Otherwise preserve the number of blank cards.
bottom : bool (optional)
If True, instead of appending after the last non-commentary card,
append after the last non-blank card.
end : bool (optional):
If True, ignore the useblanks and bottom options, and append at the
very end of the Header.
"""
if isinstance(card, str):
card = Card(card)
elif isinstance(card, tuple):
card = Card(*card)
elif card is None:
card = Card()
elif not isinstance(card, Card):
raise ValueError(
'The value appended to a Header must be either a keyword or '
'(keyword, value, [comment]) tuple; got: %r' % card)
if not end and str(card) == BLANK_CARD:
# Blank cards should always just be appended to the end
end = True
if end:
self._cards.append(card)
idx = len(self._cards) - 1
else:
idx = len(self._cards) - 1
while idx >= 0 and str(self._cards[idx]) == BLANK_CARD:
idx -= 1
if not bottom and card.keyword not in Card._commentary_keywords:
while (idx >= 0 and
self._cards[idx].keyword in Card._commentary_keywords):
idx -= 1
idx += 1
self._cards.insert(idx, card)
self._updateindices(idx)
keyword = Card.normalize_keyword(card.keyword)
self._keyword_indices[keyword].append(idx)
if not end:
# If the appended card was a commentary card, and it was appended
# before existing cards with the same keyword, the indices for
# cards with that keyword may have changed
if not bottom and card.keyword in Card._commentary_keywords:
self._keyword_indices[keyword].sort()
# Finally, if useblanks, delete a blank cards from the end
if useblanks:
self._useblanks(len(str(card)) // Card.length)
self._modified = True
def extend(self, cards, strip=True, unique=False, update=False,
update_first=False, useblanks=True, bottom=False, end=False):
"""
Appends multiple keyword+value cards to the end of the header, similar
to list.extend().
Parameters
----------
cards : iterable
An iterable of (keyword, value, [comment]) tuples; see
Header.append()
strip : bool (optional)
Remove any keywords that have meaning only to specific types of
HDUs, so that only more general keywords are added from extension
Header or Card list (default: True).
unique : bool (optional)
If `True`, ensures that no duplicate keywords are appended;
keywords already in this header are simply discarded. The
exception is commentary keywords (COMMENT, HISTORY, etc.): they are
only treated as duplicates if their values match.
update : bool (optional)
If `True`, update the current header with the values and comments
from duplicate keywords in the input header. This supercedes the
`unique` argument. Commentary keywords are treated the same as if
`unique=True`.
update_first : bool (optional)
If the first keyword in the header is 'SIMPLE', and the first
keyword in the input header is 'XTENSION', the 'SIMPLE' keyword is
replaced by the 'XTENSION' keyword. Likewise if the first keyword
in the header is 'XTENSION' and the first keyword in the input
header is 'SIMPLE', the 'XTENSION' keyword is replaced by the
'SIMPLE' keyword. This behavior is otherwise dumb as to whether or
not the resulting header is a valid primary or extension header.
This is mostly provided to support backwards compatibility with the
old :meth:`Header.fromTxtFile` method, and only applies if
`update=True`.
useblanks, bottom, end : bool (optional)
These arguments are passed to :meth:`Header.append` while appending
new cards to the header.
"""
temp = Header(cards)
if strip:
temp._strip()
if len(self):
first = self.cards[0].keyword
else:
first = None
# This copy is used to check for duplicates in this header prior to the
# extend, while not counting duplicates in the header being extended
# from (see ticket #156)
orig = self[:]
for idx, card in enumerate(temp.cards):
keyword = card.keyword
if keyword not in Card._commentary_keywords:
if unique and not update and keyword in orig:
continue
elif update:
if idx == 0 and update_first:
# Dumbly update the first keyword to either SIMPLE or
# XTENSION as the case may be, as was in the case in
# Header.fromTxtFile
if ((keyword == 'SIMPLE' and first == 'XTENSION') or
(keyword == 'XTENSION' and first == 'SIMPLE')):
del self[0]
self.insert(0, card)
else:
self[keyword] = (card.value, card.comment)
elif keyword in orig:
self[keyword] = (card.value, card.comment)
else:
self.append(card, useblanks=useblanks, bottom=bottom,
end=end)
else:
self.append(card, useblanks=useblanks, bottom=bottom,
end=end)
else:
if unique or update and keyword in orig:
if str(card) == BLANK_CARD:
self.append(card, useblanks=useblanks, bottom=bottom,
end=end)
continue
for value in orig[keyword]:
if value == card.value:
break
else:
self.append(card, useblanks=useblanks, bottom=bottom,
end=end)
else:
self.append(card, useblanks=useblanks, bottom=bottom,
end=end)
def count(self, keyword):
"""
Returns the count of the given keyword in the header, similar to
list.count() if the Header object is treated as a list of keywords.
Parameters
----------
keyword : str
The keyword to count instances of in the header
"""
keyword = Card.normalize_keyword(keyword)
# We have to look before we leap, since otherwise _keyword_indices,
# being a defaultdict, will create an entry for the nonexistent keyword
if keyword not in self._keyword_indices:
raise KeyError("Keyword %r not found." % keyword)
return len(self._keyword_indices[keyword])
def index(self, keyword, start=None, stop=None):
"""
Returns the index if the first instance of the given keyword in the
header, similar to list.index() if the Header object is treated as a
list of keywords.
Parameters
----------
keyword : str
The keyword to look up in the list of all keywords in the header
start : int (optional)
The lower bound for the index
stop : int (optional)
The upper bound for the index
"""
if start is None:
start = 0
if stop is None:
stop = len(self._cards)
if stop < start:
step = -1
else:
step = 1
norm_keyword = Card.normalize_keyword(keyword)
for idx in range(start, stop, step):
if self._cards[idx].keyword.upper() == norm_keyword:
return idx
else:
raise ValueError('The keyword %r is not in the header.' % keyword)
def insert(self, idx, card, useblanks=True):
"""
Inserts a new keyword+value card into the Header at a given location,
similar to list.insert().
Parameters
----------
idx : int
The index into the the list of header keywords before which the
new keyword should be inserted
card : str, tuple
A keyword or a (keyword, value, [comment]) tuple; see
Header.append()
useblanks : bool (optional)
If there are blank cards at the end of the Header, replace the
first blank card so that the total number of cards in the Header
does not increase. Otherwise preserve the number of blank cards.
"""
if idx >= len(self._cards):
# This is just an append (Though it must be an append absolutely to
# the bottom, ignoring blanks, etc.--the point of the insert method
# is that you get exactly what you asked for with no surprises)
self.append(card, end=True)
return
if isinstance(card, str):
card = Card(card)
elif isinstance(card, tuple):
card = Card(*card)
elif not isinstance(card, Card):
raise ValueError(
'The value inserted into a Header must be either a keyword or '
'(keyword, value, [comment]) tuple; got: %r' % card)
self._cards.insert(idx, card)
keyword = card.keyword
# If idx was < 0, determine the actual index according to the rules
# used by list.insert()
if idx < 0:
idx += len(self._cards) - 1
if idx < 0:
idx = 0
# All the keyword indices above the insertion point must be updated
self._updateindices(idx)
self._keyword_indices[keyword].append(idx)
count = len(self._keyword_indices[keyword])
if count > 1:
# There were already keywords with this same name
if keyword not in Card._commentary_keywords:
warnings.warn(
'A %r keyword already exists in this header. Inserting '
'duplicate keyword.' % keyword)
self._keyword_indices[keyword].sort()
if useblanks:
self._useblanks(len(str(card)) // Card.length)
self._modified = True
def remove(self, keyword):
"""
Removes the first instance of the given keyword from the header
similar to list.remove() if the Header object is treated as a list of
keywords.
Parameters
----------
value : str
The keyword of which to remove the first instance in the header
"""
del self[self.index(keyword)]
def rename_keyword(self, oldkeyword, newkeyword, force=False):
"""
Rename a card's keyword in the header.
Parameters
----------
oldkeyword : str or int
Old keyword or card index
newkeyword : str
New keyword
force : bool (optional)
When `True`, if the new keyword already exists in the header, force
the creation of a duplicate keyword. Otherwise a `ValueError` is
raised.
"""
oldkeyword = Card.normalize_keyword(oldkeyword)
newkeyword = Card.normalize_keyword(newkeyword)
if newkeyword == 'CONTINUE':
raise ValueError('Can not rename to CONTINUE')
if (newkeyword in Card._commentary_keywords or
oldkeyword in Card._commentary_keywords):
if not (newkeyword in Card._commentary_keywords and
oldkeyword in Card._commentary_keywords):
raise ValueError('Regular and commentary keys can not be '
'renamed to each other.')
elif not force and newkeyword in self:
raise ValueError('Intended keyword %s already exists in header.'
% newkeyword)
idx = self.index(oldkeyword)
card = self.cards[idx]
del self[idx]
self.insert(idx, (newkeyword, card.value, card.comment))
def add_history(self, value, before=None, after=None):
"""
Add a ``HISTORY`` card.
Parameters
----------
value : str
history text to be added.
before : str or int, optional
same as in `Header.update`
after : str or int, optional
same as in `Header.update`
"""
self._add_commentary('HISTORY', value, before=before, after=after)
def add_comment(self, value, before=None, after=None):
"""
Add a ``COMMENT`` card.
Parameters
----------
value : str
text to be added.
before : str or int, optional
same as in `Header.update`
after : str or int, optional
same as in `Header.update`
"""
self._add_commentary('COMMENT', value, before=before, after=after)
def add_blank(self, value='', before=None, after=None):
"""
Add a blank card.
Parameters
----------
value : str, optional
text to be added.
before : str or int, optional
same as in `Header.update`
after : str or int, optional
same as in `Header.update`
"""
self._add_commentary('', value, before=before, after=after)
def _update(self, card):
"""
The real update code. If keyword already exists, its value and/or
comment will be updated. Otherwise a new card will be appended.
This will not create a duplicate keyword except in the case of
commentary cards. The only other way to force creation of a duplicate
is to use the insert(), append(), or extend() methods.
"""
keyword, value, comment = card
# Lookups for existing/known keywords are case-insensitive
keyword = keyword.upper()
if keyword.startswith('HIERARCH '):
keyword = keyword[9:]
if (keyword not in Card._commentary_keywords and
keyword in self._keyword_indices):
# Easy; just update the value/comment
idx = self._keyword_indices[keyword][0]
existing_card = self._cards[idx]
existing_card.value = value
if comment is not None:
# '' should be used to explictly blank a comment
existing_card.comment = comment
if existing_card._modified:
self._modified = True
elif keyword in Card._commentary_keywords:
cards = self._splitcommentary(keyword, value)
if keyword in self._keyword_indices:
# Append after the last keyword of the same type
idx = self.index(keyword, start=len(self) - 1, stop=-1)
isblank = not (keyword or value or comment)
for c in reversed(cards):
self.insert(idx + 1, c, useblanks=(not isblank))
else:
for c in cards:
self.append(c, bottom=True)
else:
# A new keyword! self.append() will handle updating _modified
self.append(card)
def _cardindex(self, key):
"""Returns an index into the ._cards list given a valid lookup key."""
if isinstance(key, slice):
return key
elif isinstance(key, int):
# If < 0, determine the actual index
if key < 0:
key += len(self._cards)
if key < 0 or key >= len(self._cards):
raise IndexError('Header index out of range.')
return key
if isinstance(key, str):
key = (key, 0)
if isinstance(key, tuple):
if (len(key) != 2 or not isinstance(key[0], str) or
not isinstance(key[1], int)):
raise ValueError(
'Tuple indices must be 2-tuples consisting of a '
'keyword string and an integer index.')
keyword, n = key
keyword = Card.normalize_keyword(keyword)
# Returns the index into _cards for the n-th card with the given
# keyword (where n is 0-based)
if keyword and keyword not in self._keyword_indices:
if len(keyword) > KEYWORD_LENGTH or '.' in keyword:
raise KeyError("Keyword %r not found." % keyword)
# Great--now we have to check if there's a RVKC that starts
# with the given keyword, making failed lookups fairly
# expensive
# TODO: Find a way to make this more efficient; perhaps a set
# of RVKCs in the header or somesuch.
keyword = keyword + '.'
found = 0
for idx, card in enumerate(self._cards):
if (card.field_specifier and
card.keyword.startswith(keyword)):
if found == n:
return idx
found += 1
else:
raise KeyError("Keyword %r not found." % keyword[:-1])
try:
return self._keyword_indices[keyword][n]
except IndexError:
raise IndexError('There are only %d %r cards in the header.' %
(len(self._keyword_indices[keyword]),
keyword))
else:
raise ValueError(
'Header indices must be either a string, a 2-tuple, or '
'an integer.')
def _relativeinsert(self, card, before=None, after=None, replace=False):
"""
Inserts a new card before or after an existing card; used to
implement support for the legacy before/after keyword arguments to
Header.update().
If replace=True, move an existing card with the same keyword.
"""
if before is None:
insertionkey = after
else:
insertionkey = before
def get_insertion_idx():
if not (isinstance(insertionkey, int) and
insertionkey >= len(self._cards)):
idx = self._cardindex(insertionkey)
else:
idx = insertionkey
if before is None:
idx += 1
return idx
if replace:
# The card presumably already exists somewhere in the header.
# Check whether or not we actually have to move it; if it does need
# to be moved we just delete it and then it will be reinstered
# below
old_idx = self._cardindex(card.keyword)
insertion_idx = get_insertion_idx()
if (insertion_idx >= len(self._cards) and
old_idx == len(self._cards) - 1):
# The card would be appended to the end, but it's already at
# the end
return
if before is not None:
if old_idx == insertion_idx - 1:
return
elif after is not None and old_idx == insertion_idx:
return
del self[old_idx]
# Even if replace=True, the insertion idx may have changed since the
# old card was deleted
idx = get_insertion_idx()
if card[0] in Card._commentary_keywords:
cards = reversed(self._splitcommentary(card[0], card[1]))
else:
cards = [card]
for c in cards:
self.insert(idx, c)
def _updateindices(self, idx, increment=True):
"""
For all cards with index above idx, increment or decrement its index
value in the keyword_indices dict.
"""
if idx > len(self._cards):
# Save us some effort
return
increment = 1 if increment else -1
for indices in self._keyword_indices.values():
for jdx, keyword_index in enumerate(indices):
if keyword_index >= idx:
indices[jdx] += increment
def _countblanks(self):
"""Returns the number of blank cards at the end of the Header."""
for idx in range(1, len(self._cards)):
if str(self._cards[-idx]) != BLANK_CARD:
return idx - 1
return 0
def _useblanks(self, count):
for _ in range(count):
if str(self._cards[-1]) == BLANK_CARD:
del self[-1]
else:
break
def _haswildcard(self, keyword):
"""Return `True` if the input keyword contains a wildcard pattern."""
return (isinstance(keyword, str) and
(keyword.endswith('...') or '*' in keyword or '?' in keyword))
def _wildcardmatch(self, pattern):
"""
Returns a list of indices of the cards matching the given wildcard
pattern.
* '*' matches 0 or more alphanumeric characters or _
* '?' matches a single alphanumeric character or _
* '...' matches 0 or more of any non-whitespace character
"""
pattern = pattern.replace('*', r'\w*').replace('?', r'\w')
pattern = pattern.replace('...', r'\S*') + '$'
pattern_re = re.compile(pattern, re.I)
return [idx for idx, card in enumerate(self._cards)
if pattern_re.match(card.keyword)]
def _splitcommentary(self, keyword, value):
"""
Given a commentary keyword and value, returns a list of the one or more
cards needed to represent the full value. This is primarily used to
create the multiple commentary cards needed to represent a long value
that won't fit into a single commentary card.
"""
# The maximum value in each card can be the maximum card length minus
# the maximum key length (which can include spaces if they key length
# less than 8
maxlen = Card.length - KEYWORD_LENGTH
valuestr = str(value)
if len(valuestr) <= maxlen:
# The value can fit in a single card
cards = [Card(keyword, value)]
else:
# The value must be split across multiple consecutive commentary
# cards
idx = 0
cards = []
while idx < len(valuestr):
cards.append(Card(keyword, valuestr[idx:idx + maxlen]))
idx += maxlen
return cards
def _strip(self):
"""
Strip cards specific to a certain kind of header.
Strip cards like ``SIMPLE``, ``BITPIX``, etc. so the rest of
the header can be used to reconstruct another kind of header.
"""
# TODO: Previously this only deleted some cards specific to an HDU if
# _hdutype matched that type. But it seemed simple enough to just
# delete all desired cards anyways, and just ignore the KeyErrors if
# they don't exist.
# However, it might be desirable to make this extendable somehow--have
# a way for HDU classes to specify some headers that are specific only
# to that type, and should be removed otherwise.
if 'NAXIS' in self:
naxis = self['NAXIS']
else:
naxis = 0
if 'TFIELDS' in self:
tfields = self['TFIELDS']
else:
tfields = 0
for idx in range(naxis):
try:
del self['NAXIS' + str(idx + 1)]
except KeyError:
pass
for name in ('TFORM', 'TSCAL', 'TZERO', 'TNULL', 'TTYPE',
'TUNIT', 'TDISP', 'TDIM', 'THEAP', 'TBCOL'):
for idx in range(tfields):
try:
del self[name + str(idx + 1)]
except KeyError:
pass
for name in ('SIMPLE', 'XTENSION', 'BITPIX', 'NAXIS', 'EXTEND',
'PCOUNT', 'GCOUNT', 'GROUPS', 'BSCALE', 'BZERO',
'TFIELDS'):
try:
del self[name]
except KeyError:
pass
def _add_commentary(self, key, value, before=None, after=None):
"""
Add a commentary card.
If `before` and `after` are `None`, add to the last occurrence
of cards of the same name (except blank card). If there is no
card (or blank card), append at the end.
"""
if before is not None or after is not None:
self._relativeinsert((key, value), before=before,
after=after)
else:
self[key] = value
# Some fixes for compatibility with the Python 3 dict interface, where
# iteritems -> items, etc.
if PY3K: # pragma: py3
keys = iterkeys
values = itervalues
items = iteritems
del iterkeys
del itervalues
del iteritems
# The following properties/methods are for legacy API backwards
# compatibility
@property
@deprecated('3.1', alternative='the `.cards` attribute')
def ascard(self):
"""
Returns a CardList object wrapping this Header; provided for
backwards compatibility for the old API (where Headers had an
underlying CardList).
"""
return CardList(self)
@deprecated('3.1', alternative=':meth:`Header.rename_keyword`')
def rename_key(self, oldkey, newkey, force=False):
self.rename_keyword(oldkey, newkey, force)
@deprecated('3.1', alternative="``header['HISTORY']``")
def get_history(self):
"""
Get all history cards as a list of string texts.
"""
if 'HISTORY' in self:
return self['HISTORY']
else:
return []
@deprecated('3.1', alternative="``header['COMMENT']``")
def get_comment(self):
"""
Get all comment cards as a list of string texts.
"""
if 'COMMENT' in self:
return self['COMMENT']
else:
return []
@deprecated('3.1', alternative=':meth:`Header.totextfile`')
def toTxtFile(self, fileobj, clobber=False):
"""
Output the header parameters to a file in ASCII format.
Parameters
----------
fileobj : file path, file object or file-like object
Output header parameters file.
clobber : bool
When `True`, overwrite the output file if it exists.
"""
self.tofile(fileobj, sep='\n', endcard=False, padding=False,
clobber=clobber)
@deprecated('3.1',
message='This is equivalent to '
'``self.extend(Header.fromtextfile(fileobj), '
'update=True, update_first=True)``. Note that there '
'there is no direct equivalent to the '
'``replace=True`` option since '
':meth:`Header.fromtextfile` returns a new '
':class:`Header` instance.')
def fromTxtFile(self, fileobj, replace=False):
"""
Input the header parameters from an ASCII file.
The input header cards will be used to update the current
header. Therefore, when an input card key matches a card key
that already exists in the header, that card will be updated
in place. Any input cards that do not already exist in the
header will be added. Cards will not be deleted from the
header.
Parameters
----------
fileobj : file path, file object or file-like object
Input header parameters file.
replace : bool, optional
When `True`, indicates that the entire header should be
replaced with the contents of the ASCII file instead of
just updating the current header.
"""
input_header = Header.fromfile(fileobj, sep='\n', endcard=False,
padding=False)
if replace:
self.clear()
prev_key = 0
for card in input_header.cards:
card.verify('silentfix')
if card.keyword == 'SIMPLE':
if self.get('XTENSION'):
del self.ascard['XTENSION']
self.set(card.keyword, card.value, card.comment, before=0)
prev_key = 0
elif card.keyword == 'XTENSION':
if self.get('SIMPLE'):
del self.ascard['SIMPLE']
self.set(card.keyword, card.value, card.comment, before=0)
prev_key = 0
elif card.keyword in Card._commentary_keywords:
if (not replace and
not (card.keyword == '' and card.value == '')):
# Don't add duplicate commentary cards (though completely
# blank cards are allowed to be duplicated)
for c in self.cards:
if c.keyword == card.keyword and c.value == card.value:
break
else:
self.set(card.keyword, card.value, after=prev_key)
prev_key += 1
else:
self.set(card.keyword, card.value, after=prev_key)
prev_key += 1
else:
self.set(card.keyword, card.value, card.comment,
after=prev_key)
prev_key += 1
class _CardAccessor(object):
"""
This is a generic class for wrapping a Header in such a way that you can
use the header's slice/filtering capabilities to return a subset of cards
and do something of them.
This is sort of the opposite notion of the old CardList class--whereas
Header used to use CardList to get lists of cards, this uses Header to get
lists of cards.
"""
# TODO: Consider giving this dict/list methods like Header itself
def __init__(self, header):
self._header = header
def __repr__(self):
return '\n'.join(repr(c) for c in self._header._cards)
def __len__(self):
return len([c for c in self])
def __eq__(self, other):
if isiterable(other):
for a, b in zip(self, other):
if a != b:
return False
else:
return True
return False
def __getitem__(self, item):
if isinstance(item, slice) or self._header._haswildcard(item):
return self.__class__(self._header[item])
idx = self._header._cardindex(item)
return self._header._cards[idx]
def _setslice(self, item, value):
"""
Helper for implementing __setitem__ on _CardAccessor subclasses; slices
should always be handled in this same way.
"""
if isinstance(item, slice) or self._header._haswildcard(item):
if isinstance(item, slice):
indices = range(*item.indices(len(self)))
else:
indices = self._header._wildcardmatch(item)
if isinstance(value, str) or not isiterable(value):
value = itertools.repeat(value, len(indices))
for idx, val in zip(indices, value):
self[idx] = val
return True
return False
class _HeaderComments(_CardAccessor):
"""
A class used internally by the Header class for the Header.comments
attribute access.
This object can be used to display all the keyword comments in the Header,
or look up the comments on specific keywords. It allows all the same forms
of keyword lookup as the Header class itself, but returns comments instead
of values.
"""
def __repr__(self):
"""Returns a simple list of all keywords and their comments."""
keyword_length = KEYWORD_LENGTH
for card in self._header._cards:
keyword_length = max(keyword_length, len(card.keyword))
return '\n'.join('%*s %s' % (keyword_length, c.keyword, c.comment)
for c in self._header._cards)
def __getitem__(self, item):
"""
Slices and filter strings return a new _HeaderComments containing the
returned cards. Otherwise the comment of a single card is returned.
"""
item = super(_HeaderComments, self).__getitem__(item)
if isinstance(item, _HeaderComments):
return item
return item.comment
def __setitem__(self, item, comment):
"""
Set/update the comment on specified card or cards.
Slice/filter updates work similarly to how Header.__setitem__ works.
"""
if self._setslice(item, comment):
return
# In this case, key/index errors should be raised; don't update
# comments of nonexistent cards
idx = self._header._cardindex(item)
value = self._header[idx]
self._header[idx] = (value, comment)
class _HeaderCommentaryCards(_CardAccessor):
def __init__(self, header, keyword=''):
super(_HeaderCommentaryCards, self).__init__(header)
self._keyword = keyword
self._count = self._header.count(self._keyword)
self._indices = slice(self._count).indices(self._count)
def __repr__(self):
return '\n'.join(self)
def __getitem__(self, idx):
if isinstance(idx, slice):
n = self.__class__(self._header, self._keyword)
n._indices = idx.indices(self._count)
return n
elif not isinstance(idx, int):
raise ValueError('%s index must be an integer' % self._keyword)
idx = list(range(*self._indices))[idx]
return self._header[(self._keyword, idx)]
def __setitem__(self, item, value):
"""
Set the value of a specified commentary card or cards.
Slice/filter updates work similarly to how Header.__setitem__ works.
"""
if self._setslice(item, value):
return
# In this case, key/index errors should be raised; don't update
# comments of nonexistent cards
self._header[(self._keyword, item)] = value
def _is_pyfits_internal():
"""
Returns True if the stack frame this is called from is in code internal to
the the pyfits package.
This is used in a few places where hacks are employed for backwards
compatibility with the old header API, but where we want to avoid using
those hacks internally.
"""
calling_mod = inspect.getmodule(sys._getframe(2))
return calling_mod and calling_mod.__name__.startswith('pyfits.')
def _block_size(sep):
"""
Determine the size of a FITS header block if a non-blank separator is used
between cards.
"""
return BLOCK_SIZE + (len(sep) * (BLOCK_SIZE // Card.length - 1))
|