Hide keyboard shortcuts

Hot-keys on this page

r m x p   toggle line displays

j k   next/prev highlighted chunk

0   (zero) top of page

1   (one) first highlighted chunk

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

# Licensed under a 3-clause BSD style license - see yanny-LICENSE.rst 

# -*- coding: utf-8 -*- 

"""Python library for reading & writing yanny files. 

 

yanny is an object-oriented interface to FTCL/yanny data files following 

these specifications_. 

 

The format of the returned object is similar to that returned by 

``read_yanny()`` in the efftickle perl package (in the yannytools product). 

 

Currently multidimensional arrays are only supported for type ``char``, and a 

close reading of the specifications indicates that multidimensional arrays 

were only ever intended to be supported for type ``char``. So no 

multidimensional arrays, sorry. 

 

.. _specifications: http://www.sdss3.org/dr8/software/par.php 

 

LSST NOTE: 

This file was copied from the version in pydl 0.4.1: 

 

https://github.com/weaverba137/pydl/blob/0.4.1/pydl/pydlutils/yanny/yanny.py 

 

It is used for the makeCcd step of makeCamera, to read the opConfig and opECalib 

files in etc/. 

""" 

 

# 

# Modules 

# 

from __future__ import print_function 

from builtins import range 

from past.builtins import basestring 

import re 

import os 

import os.path 

import datetime 

import numpy 

 

 

class yanny(dict): # noqa N801 

"""An object interface to a yanny file. 

 

Create a yanny object using a yanny file, `filename`. If the file exists, 

it is read, & the dict structure of the object will be basically the 

same as that returned by ``read_yanny()`` in the efftickle package. 

 

If the file does not exist, or if no filename is given, a blank 

structure is returned. Other methods allow for subsequent writing 

to the file. 

 

Parameters 

---------- 

filename : str or file-like, optional 

The name of a yanny file or a file-like object representing a yanny file. 

np : bool, optional 

If ``True``, data in a yanny file will be converted into a NumPy record 

array. Default is ``False``. 

debug : bool, optional 

If ``True``, some simple debugging statements will be turned on. Default 

is ``False``. 

 

Attributes 

---------- 

np : bool 

If True, data in a yanny file will be converted into a NumPy record 

array. 

debug : bool 

If True, some simple debugging statements will be turned on. 

filename : str 

The name of a yanny parameter file. If a file-like object was used 

to initialize the object, this will have the value 'in_memory.par'. 

_contents : str 

The complete contents of a yanny parameter file. 

_struct_type_caches : dict 

A dictionary of dictionaries, one dictionary for every structure 

definition in a yanny parameter file. Contains the types of 

each column 

_struct_isarray_caches : dict 

A dictionary of dictionaries, one dictionary for every structure 

definition in a yanny parameter file. Contains a boolean value 

for every column. 

_enum_cache : dict 

Initially ``None``, this attribute is initialized the first time 

the ``isenum()`` method is called. The keyword is the name of the 

enum type, the value is a list of the possible values of that type. 

 

""" 

# 

# 

# 

@staticmethod 

def get_token(string): 

"""Removes the first 'word' from string. 

 

If the 'word' is enclosed in double quotes, it returns the 

contents of the double quotes. If the 'word' is enclosed in 

braces, it returns the contents of the braces, but does not 

attempt to split the array. If the 'word' is the last word of the 

string, remainder is set equal to the empty string. This is 

basically a wrapper on some convenient regular expressions. 

 

Parameters 

---------- 

string : str 

A string containing words. 

 

Returns 

------- 

get_token : tuple 

A tuple containing the first word and the remainder of the string. 

 

Examples 

-------- 

>>> from pydl.pydlutils.yanny import yanny 

>>> yanny.get_token("The quick brown fox") 

('The', 'quick brown fox') 

""" 

if string[0] == '"': 

(word, remainder) = re.search(r'^"([^"]*)"\s*(.*)', 

string).groups() 

elif string[0] == '{': 

(word, remainder) = re.search(r'^\{\s*([^}]*)\s*\}\s*(.*)', 

string).groups() 

else: 

try: 

(word, remainder) = re.split(r'\s+', string, 1) 

except ValueError: 

(word, remainder) = (string, '') 

if remainder is None: 

remainder = '' 

return (word, remainder) 

# 

# 

# 

 

@staticmethod 

def protect(x): 

"""Used to appropriately quote string that might contain whitespace. 

 

This method is mostly for internal use by the yanny object. 

 

Parameters 

---------- 

x : str 

The data to protect. 

 

Returns 

------- 

protect : str 

The data with white space protected by quotes. 

 

Examples 

-------- 

>>> from pydl.pydlutils.yanny import yanny 

>>> yanny.protect('This string contains whitespace.') 

'"This string contains whitespace."' 

>>> yanny.protect('This string contains a #hashtag.') 

'"This string contains a #hashtag."' 

""" 

if isinstance(x, numpy.bytes_): 

s = x.decode() 

else: 

s = str(x) 

if len(s) == 0 or s.find('#') >= 0 or re.search(r'\s+', s) is not None: 

return '"' + s + '"' 

else: 

return s 

# 

# 

# 

 

@staticmethod 

def trailing_comment(line): 

"""Identify a trailing comment and strip it. 

 

This routine works on the theory that a properly quoted comment mark 

will be surrounted by an odd number of double quotes, & we can 

skip to searching for the last one in the line. 

 

Parameters 

---------- 

line : str 

A line from a yanny file potentially containing trailing comments. 

 

Returns 

------- 

trailing_comment : str 

The line with any trailing comment and any residual white space 

trimmed off. 

 

Notes 

----- 

This may fail in certain pathological cases, for example if a 

real trailing comment contains a single double-quote:: 

 

# a 'pathological" trailing comment 

 

or if someone is over-enthusiastically commenting:: 

 

# # # # # I like # characters. 

 

Examples 

-------- 

>>> from pydl.pydlutils.yanny import yanny 

>>> yanny.trailing_comment('mystruct 1234 "#hashtag" # a comment.') 

'mystruct 1234 "#hashtag"' 

>>> yanny.trailing_comment('mystruct 1234 "#hashtag" # a "comment".') 

'mystruct 1234 "#hashtag"' 

""" 

lastmark = line.rfind('#') 

if lastmark >= 0: 

# 

# Count the number of double quotes in the remainder of the line 

# 

if (len([c for c in line[lastmark:] if c == '"']) % 2) == 0: 

# 

# Even number of quotes 

# 

return line[0:lastmark].rstrip() 

return line 

# 

# 

# 

 

@staticmethod 

def dtype_to_struct(dt, structname='mystruct', enums=None): 

"""Convert a NumPy dtype object describing a record array to 

a typedef struct statement. 

 

The second argument is the name of the structure. 

If any of the columns are enum types, enums must 

be a dictionary with the keys the column names, and the values 

are a tuple containing the name of the enum type as the first item 

and a tuple or list of possible values as the second item. 

 

Parameters 

---------- 

dt : numpy.dtype 

The dtype of a NumPy record array. 

structname : str, optional 

The name to give the structure in the yanny file. Defaults to 'MYSTRUCT'. 

enums : dict, optional 

A dictionary containing enum information. See details above. 

 

Returns 

------- 

dtype_to_struct : dict 

A dictionary suitable for setting the 'symbols' dictionary of a new 

yanny object. 

 

Examples 

-------- 

""" 

dtmap = {'i2': 'short', 'i4': 'int', 'i8': 'long', 'f4': 'float', 

'f8': 'double'} 

returnenums = list() 

if enums is not None: 

for e in enums: 

lines = list() 

lines.append('typedef enum {') 

for n in enums[e][1]: 

lines.append(" {0},".format(n)) 

lines[-1] = lines[-1].strip(',') 

lines.append('}} {0};'.format(enums[e][0].upper())) 

returnenums.append("\n".join(lines)) 

# lines.append('') 

lines = list() 

lines.append('typedef struct {') 

for c in dt.names: 

if dt[c].kind == 'V': 

t = dt[c].subdtype[0].str[1:] 

l = dt[c].subdtype[1][0] # noqa E741 

s = dt[c].subdtype[0].itemsize 

else: 

t = dt[c].str[1:] 

l = 0 # noqa E741 

s = dt[c].itemsize 

line = ' ' 

if t[0] == 'S': 

if c in enums: 

line += enums[c][0].upper() 

else: 

line += 'char' 

else: 

line += dtmap[t] 

line += ' {0}'.format(c) 

if l > 0: 

line += "[{0:d}]".format(l) 

if t[0] == 'S' and c not in enums: 

line += "[{0:d}]".format(s) 

line += ';' 

lines.append(line) 

lines.append('}} {0};'.format(structname.upper())) 

return {structname.upper(): list(dt.names), 'enum': returnenums, 'struct': ["\n".join(lines)]} 

# 

# 

# 

 

def __init__(self, filename=None, np=False, debug=False): 

"""Create a yanny object using a yanny file. 

""" 

# 

# The symbol hash is inherited from the old read_yanny 

# 

self['symbols'] = dict() 

# 

# Create special attributes that contain the internal status of the object 

# this should prevent overlap with keywords in the data files 

# 

self.filename = '' 

self._contents = '' 

# 

# Since the re is expensive, cache the structure types keyed by the field. 

# Create a dictionary for each structure found. 

# 

self._struct_type_caches = dict() 

self._struct_isarray_caches = dict() 

self._enum_cache = None 

# 

# Optionally convert numeric data into NumPy arrays 

# 

self.np = np 

# 

# Turn on simple debugging 

# 

self.debug = debug 

# 

# If the file exists, read it 

# 

if filename is not None: 

# 

# Handle file-like objects 

# 

# NOTE: commented out to remove astropy.extern.six dependency 

# NOTE: Should be revisited when Python 3 support is added to the stack 

# if isinstance(filename, six.string_types): 

if isinstance(filename, basestring): 

if os.access(filename, os.R_OK): 

self.filename = filename 

with open(filename, 'r') as f: 

self._contents = f.read() 

else: 

# 

# Assume file-like 

# 

self.filename = 'in_memory.par' 

self._contents = filename.read() 

self._parse() 

return 

# 

# 

# 

 

def __str__(self): 

"""Implement the ``str()`` function for yanny objects. 

 

Simply prints the current contents of the yanny file. 

""" 

return self._contents 

# 

# 

# 

 

def __eq__(self, other): 

"""Test two yanny objects for equality. 

 

Two yanny objects are assumed to be equal if their contents are equal. 

""" 

if isinstance(other, yanny): 

return str(other) == str(self) 

return NotImplemented 

# 

# 

# 

 

def __ne__(self, other): 

"""Test two yanny objects for inequality. 

 

Two yanny objects are assumed to be unequal if their contents are unequal. 

""" 

if isinstance(other, yanny): 

return str(other) != str(self) 

return NotImplemented 

# 

# 

# 

 

def __bool__(self): 

"""Give a yanny object a definite truth value. 

 

A yanny object is considered ``True`` if its contents are non-zero. 

""" 

return len(self._contents) > 0 

 

# `__nonzero__` is needed for Python 2. 

# Python 3 uses `__bool__`. 

# http://stackoverflow.com/a/2233850/498873 

__nonzero__ = __bool__ 

 

# 

# 

# 

def type(self, structure, variable): 

"""Returns the type of a variable defined in a structure. 

 

Returns ``None`` if the structure or the variable is undefined. 

 

Parameters 

---------- 

structure : str 

The name of the structure that contains `variable`. 

variable : str 

The name of the column whose type you want. 

 

Returns 

------- 

type : str 

The type of the variable. 

""" 

if structure not in self: 

return None 

if variable not in self.columns(structure): 

return None 

# 

# Added code to cache values to speed up parsing large files. 

# 2009.05.11 / Demitri Muna, NYU 

# Find (or create) the cache for this structure. 

# 

try: 

cache = self._struct_type_caches[structure] 

except KeyError: 

self._struct_type_caches[structure] = dict() 

cache = self._struct_type_caches[structure] # cache for one struct type 

# 

# Lookup (or create) the value for this variable 

# 

try: 

var_type = cache[variable] 

except KeyError: 

if self.debug: 

print(variable) 

defl = [x for x in self['symbols']['struct'] if x.find(structure.lower()) > 0] 

defu = [x for x in self['symbols']['struct'] if x.find(structure.upper()) > 0] 

if len(defl) != 1 and len(defu) != 1: 

return None 

elif len(defl) == 1: 

definition = defl 

else: 

definition = defu 

typere = re.compile(r'(\S+)\s+{0}([[<].*[]>]|);'.format(variable)) 

(typ, array) = typere.search(definition[0]).groups() 

var_type = typ + array.replace('<', '[').replace('>', ']') 

cache[variable] = var_type 

return var_type 

# 

# 

# 

 

def basetype(self, structure, variable): 

"""Returns the bare type of a variable, stripping off any array information. 

 

Parameters 

---------- 

structure : str 

The name of the structure that contains `variable`. 

variable : str 

The name of the column whose type you want. 

 

Returns 

------- 

basetype : str 

The type of the variable, stripped of array information. 

""" 

typ = self.type(structure, variable) 

if self.debug: 

print(variable, typ) 

try: 

return typ[0:typ.index('[')] 

except ValueError: 

return typ 

# 

# 

# 

 

def isarray(self, structure, variable): 

"""Returns ``True`` if the variable is an array type. 

 

For character types, this means a two-dimensional array, 

*e.g.*: ``char[5][20]``. 

 

Parameters 

---------- 

structure : str 

The name of the structure that contains `variable`. 

variable : str 

The name of the column to check for array type. 

 

Returns 

------- 

isarray : bool 

``True`` if the variable is an array. 

""" 

try: 

cache = self._struct_isarray_caches[structure] 

except KeyError: 

self._struct_isarray_caches[structure] = dict() 

cache = self._struct_isarray_caches[structure] 

try: 

result = cache[variable] 

except KeyError: 

typ = self.type(structure, variable) 

character_array = re.compile(r'char[[<]\d*[]>][[<]\d*[]>]') 

if ((character_array.search(typ) is not None) or 

(typ.find('char') < 0 and (typ.find('[') >= 0 or 

typ.find('<') >= 0))): 

cache[variable] = True 

else: 

cache[variable] = False 

result = cache[variable] 

return result 

# 

# 

# 

 

def isenum(self, structure, variable): 

"""Returns true if a variable is an enum type. 

 

Parameters 

---------- 

structure : str 

The name of the structure that contains `variable`. 

variable : str 

The name of the column to check for enum type. 

 

Returns 

------- 

isenum : bool 

``True`` if the variable is enum type. 

""" 

if self._enum_cache is None: 

self._enum_cache = dict() 

if 'enum' in self['symbols']: 

for e in self['symbols']['enum']: 

m = re.search(r'typedef\s+enum\s*\{([^}]+)\}\s*(\w+)\s*;', e).groups() 

self._enum_cache[m[1]] = re.split(r',\s*', m[0].strip()) 

else: 

return False 

return self.basetype(structure, variable) in self._enum_cache 

# 

# 

# 

 

def array_length(self, structure, variable): 

"""Returns the length of an array type or 1 if the variable is not an array. 

 

For character types, this is the length of a two-dimensional 

array, *e.g.*, ``char[5][20]`` has length 5. 

 

Parameters 

---------- 

structure : str 

The name of the structure that contains `variable`. 

variable : str 

The name of the column to check for array length. 

 

Returns 

------- 

array_length : int 

The length of the array variable 

""" 

if self.isarray(structure, variable): 

typ = self.type(structure, variable) 

return int(typ[typ.index('[')+1:typ.index(']')]) 

else: 

return 1 

# 

# 

# 

 

def char_length(self, structure, variable): 

"""Returns the length of a character field. 

 

*e.g.* ``char[5][20]`` is an array of 5 strings of length 20. 

Returns ``None`` if the variable is not a character type. If the 

length is not specified, *i.e.* ``char[]``, it returns the length of 

the largest string. 

 

Parameters 

---------- 

structure : str 

The name of the structure that contains `variable`. 

variable : str 

The name of the column to check for char length. 

 

Returns 

------- 

char_length : int or None 

The length of the char variable. 

""" 

typ = self.type(structure, variable) 

if typ.find('char') < 0: 

return None 

try: 

return int(typ[typ.rfind('[')+1:typ.rfind(']')]) 

except ValueError: 

if self.isarray(structure, variable): 

return max([max([len(x) for x in r]) for r in self[structure][variable]]) 

else: 

return max([len(x) for x in self[structure][variable]]) 

# 

# 

# 

 

def dtype(self, structure): 

"""Returns a NumPy dtype object suitable for describing a table as a record array. 

 

Treats enums as string, which is what the IDL reader does. 

 

Parameters 

---------- 

structure : str 

The name of the structure. 

 

Returns 

------- 

dtype : numpy.dtype 

A dtype object suitable for describing the yanny structure as a record array. 

""" 

dt = list() 

dtmap = {'short': 'i2', 'int': 'i4', 'long': 'i8', 'float': 'f', 

'double': 'd'} 

for c in self.columns(structure): 

typ = self.basetype(structure, c) 

if typ == 'char': 

d = "S{0:d}".format(self.char_length(structure, c)) 

elif self.isenum(structure, c): 

d = "S{0:d}".format(max([len(x) for x in self._enum_cache[typ]])) 

else: 

d = dtmap[typ] 

if self.isarray(structure, c): 

dt.append((c, d, (self.array_length(structure, c),))) 

else: 

dt.append((c, d)) 

dt = numpy.dtype(dt) 

return dt 

# 

# 

# 

 

def convert(self, structure, variable, value): 

"""Converts value into the appropriate (Python) type. 

 

* ``short`` & ``int`` are converted to Python ``int``. 

* ``long`` is converted to Python ``long``. 

* ``float`` & ``double`` are converted to Python ``float``. 

* Other types are not altered. 

 

There may be further conversions into NumPy types, but this is the 

first stage. 

 

Parameters 

---------- 

structure : str 

The name of the structure that contains `variable`. 

variable : str 

The name of the column undergoing conversion. 

value : str 

The value contained in a particular row of `variable`. 

 

Returns 

------- 

convert : int, long, float or str 

`value` converted to a Python numerical type. 

""" 

typ = self.basetype(structure, variable) 

if (typ == 'short' or typ == 'int'): 

if self.isarray(structure, variable): 

return [int(v) for v in value] 

else: 

return int(value) 

if typ == 'long': 

if self.isarray(structure, variable): 

return [int(v) for v in value] 

else: 

return int(value) 

if (typ == 'float' or typ == 'double'): 

if self.isarray(structure, variable): 

return [float(v) for v in value] 

else: 

return float(value) 

return value 

# 

# 

# 

 

def tables(self): 

"""Returns a list of all the defined structures. 

 

This is just the list of keys of the object with the 'internal' 

keys removed. 

""" 

foo = list() 

for k in self['symbols']: 

if k not in ('struct', 'enum'): 

foo.append(k) 

return foo 

# 

# 

# 

 

def columns(self, table): 

"""Returns an ordered list of column names associated with a particular table. 

 

The order is the same order as they are defined in the yanny file. 

 

Parameters 

---------- 

table : str 

The table whose columns are desired. 

 

Returns 

------- 

columns : list 

The list of column names. 

""" 

foo = list() 

if table in self['symbols']: 

return self['symbols'][table] 

return foo 

# 

# 

# 

 

def size(self, table): 

"""Returns the number of rows in a table. 

 

Parameters 

---------- 

table : str 

The table whose size desired. 

 

Returns 

------- 

size : int 

The number of rows in `table`. 

""" 

foo = self.columns(table) 

return len(self[table][foo[0]]) 

# 

# 

# 

 

def pairs(self): 

"""Returns a list of keys to keyword/value pairs. 

 

Equivalent to doing ``self.keys()``, but with all the data tables & 

other control structures stripped out. 

""" 

p = list() 

foo = self.tables() 

for k in list(self.keys()): 

if k != 'symbols' and k not in foo: 

p.append(k) 

return p 

# 

# 

# 

 

def row(self, table, index): 

"""Returns a list containing a single row from a specified table in column order 

 

If index is out of range, it returns an empty list. 

 

If the yanny object instance is set up for NumPy record arrays, then 

a single row can be obtained with:: 

 

row0 = par['TABLE'][0] 

 

Parameters 

---------- 

table : str 

The table whose row is desired. 

index : int 

The number of the row to return. 

 

Returns 

------- 

row : list 

A row from `table`. 

""" 

datarow = list() 

if table in self and index >= 0 and index < self.size(table): 

for c in self.columns(table): 

datarow.append(self[table][c][index]) 

return datarow 

# 

# 

# 

 

def list_of_dicts(self, table): 

"""Construct a list of dictionaries. 

 

Takes a table from the yanny object and constructs a list object 

containing one row per entry. Each item in the list is a dictionary 

keyed by the struct value names. 

 

If the yanny object instance is set up for NumPy record arrays, then 

the same functionality can be obtained with:: 

 

foo = par['TABLE'][0]['column'] 

 

Parameters 

---------- 

table : str 

The table to convert 

 

Returns 

------- 

list_of_dicts : list 

A list containing the rows of `table` converted to ``dict``. 

""" 

return_list = list() 

d = dict() 

struct_fields = self.columns(table) # I'm assuming these are in order... 

for i in range(self.size(table)): 

one_row = self.row(table, i) # one row as a list 

j = 0 

for key in struct_fields: 

d[key] = one_row[j] 

j = j + 1 

return_list.append(dict(d)) # append a new dict (copy of d) 

return return_list 

# 

# 

# 

 

def new_dict_from_pairs(self): 

"""Returns a new dictionary of keyword/value pairs. 

 

The new dictionary (*i.e.*, not a yanny object) contains the keys 

that ``self.pairs()`` returns. There are two reasons this is convenient: 

 

* the key 'symbols' that is part of the yanny object will not be present 

* a simple yanny file can be read with no further processing 

 

Examples 

-------- 

 

Read a yanny file and return only the pairs:: 

 

>>> from os.path import dirname 

>>> from pydl.pydlutils.yanny import yanny 

>>> new_dict = yanny(dirname(__file__)+'/tests/t/test.par').new_dict_from_pairs() 

>>> new_dict['mjd'] 

'54579' 

>>> new_dict['alpha'] 

'beta gamma delta' 

 

added: Demitri Muna, NYU 2009-04-28 

""" 

new_dictionary = dict() 

for key in self.pairs(): 

new_dictionary[key] = self[key] 

return new_dictionary 

# 

# 

# 

 

def write(self, newfile=None, comments=None): 

"""Write a yanny object to a file. 

 

This assumes that the filename used to create the object was not that 

of a pre-existing file. If a file of the same name is detected, 

this method will *not* attempt to overwrite it, but will print a warning. 

This also assumes that the special 'symbols' key has been properly 

created. This will not necessarily make the file very human-readable, 

especially if the data lines are long. If the name of a new file is 

given, it will write to the new file (assuming it doesn't exist). 

If the writing is successful, the data in the object will be updated. 

 

Parameters 

---------- 

newfile : str, optional 

The name of the file to write. 

comments : str or list of str, optional 

Comments that will be placed at the head of the file. If a 

single string is passed, it will be written out verbatim, so it 

had better contain '#' characters. If a list of strings is 

passed, comment characters will be added and the strings 

will be joined together. 

""" 

if newfile is None: 

if len(self.filename) > 0: 

newfile = self.filename 

else: 

raise ValueError("No filename specified!") 

if comments is None: 

basefile = os.path.basename(newfile) 

timestamp = datetime.datetime.utcnow().strftime('%Y-%m-%d %H:%M:%S UTC') 

comments = "#\n# {0}\n#\n# Created by pydl.pydlutils.yanny.yanny\n#\n# {1}\n#\n".format( 

basefile, timestamp) 

else: 

if not isinstance(comments, str): 

comments = "\n".join(["# {0}".format(c) for c in comments]) + "\n" 

contents = comments 

# 

# Print any key/value pairs 

# 

for key in self.pairs(): 

contents += "{0} {1}\n".format(key, self[key]) 

# 

# Print out enum definitions 

# 

if len(self['symbols']['enum']) > 0: 

contents += "\n" + "\n\n".join(self['symbols']['enum']) + "\n" 

# 

# Print out structure definitions 

# 

if len(self['symbols']['struct']) > 0: 

contents += "\n" + "\n\n".join(self['symbols']['struct']) + "\n" 

contents += "\n" 

# 

# Print out the data tables 

# 

for sym in self.tables(): 

columns = self.columns(sym) 

for k in range(self.size(sym)): 

line = list() 

line.append(sym) 

for col in columns: 

if self.isarray(sym, col): 

datum = '{' + ' '.join([self.protect(x) for x in self[sym][col][k]]) + '}' 

else: 

datum = self.protect(self[sym][col][k]) 

line.append(datum) 

contents += "{0}\n".format(' '.join(line)) 

# 

# Actually write the data to file 

# 

if os.access(newfile, os.F_OK): 

print("{0} exists, aborting write!".format(newfile)) 

print("For reference, here's what would have been written:") 

print(contents) 

else: 

with open(newfile, 'w') as f: 

f.write(contents) 

self._contents = contents 

self.filename = newfile 

self._parse() 

return 

# 

# 

# 

 

def append(self, datatable): 

"""Appends data to an existing FTCL/yanny file. 

 

Tries as much as possible to preserve the ordering & format of the 

original file. The datatable should adhere to the format of the 

yanny object, but it is not necessary to reproduce the 'symbols' 

dictionary. It will not try to append data to a file that does not 

exist. If the append is successful, the data in the object will be updated. 

 

Parameters 

---------- 

datatable : dict 

The data to append. 

""" 

if len(self.filename) == 0: 

raise ValueError( 

"No filename is set for this object. Use the filename attribute to set the filename!") 

if type(datatable) != dict: 

raise ValueError("Data to append is not of the correct type. Use a dict!") 

timestamp = datetime.datetime.utcnow().strftime('%Y-%m-%d %H:%M:%S UTC') 

contents = '' 

# 

# Print any key/value pairs 

# 

for key in datatable: 

if key.upper() in self.tables() or key == 'symbols': 

continue 

contents += "{0} {1}\n".format(key, datatable[key]) 

# 

# Print out the data tables 

# 

for sym in self.tables(): 

if sym.lower() in datatable: 

datasym = sym.lower() 

else: 

datasym = sym 

if datasym in datatable: 

columns = self.columns(sym) 

for k in range(len(datatable[datasym][columns[0]])): 

line = list() 

line.append(sym) 

for col in columns: 

if self.isarray(sym, col): 

datum = '{' + ' '.join([self.protect(x) 

for x in datatable[datasym][col][k]]) + '}' 

else: 

datum = self.protect(datatable[datasym][col][k]) 

line.append(datum) 

contents += "{0}\n".format(' '.join(line)) 

# 

# Actually write the data to file 

# 

if len(contents) > 0: 

contents = ("# Appended by yanny.py at {0}.\n".format(timestamp)) + contents 

if os.access(self.filename, os.W_OK): 

with open(self.filename, 'a') as f: 

f.write(contents) 

self._contents += contents 

self._parse() 

else: 

print("{0} does not exist, aborting append!".format(self.filename)) 

print("For reference, here's what would have been written:") 

print(contents) 

else: 

print("Nothing to be appended!") 

return 

# 

# 

# 

 

def _parse(self): 

"""Converts text into tables that users can use. 

 

This method is for use internally by the yanny object. It is not 

meant to be called by users. 

 

Parsing proceeds in this order: 

 

#. Lines that end with a backslash character ``\`` are reattached 

to following lines. 

#. Structure & enum definitions are identified, saved into the 

'symbols' dictionary & stripped from the contents. 

#. Structure definitions are interpreted. 

#. At this point, the remaining lines of the original file can only 

contain these things: 

 

* 'blank' lines, including lines that only contain comments 

* keyword/value pairs 

* structure rows 

 

#. The remaining lines are scanned sequentially. 

 

#. 'Blank' lines are identified & ignored. 

#. Whitespace & comments are stripped from non-blank lines. 

#. Empty double braces ``{{}}`` are converted into empty double 

quotes ``""``. 

#. If the first word on a line matches the name of a structure, 

the line is broken up into tokens & each token or set of tokens 

(for arrays) is converted to the appropriate Python type. 

#. If the first word on a line does not match the name of a 

structure, it must be a keyword, so this line is interpreted 

as a keyword/value pair. No further processing is done to 

the value. 

 

#. At the conclusion of parsing, if ``self.np`` is ``True``, the 

structures are converted into NumPy record arrays. 

""" 

# 

# there are five things we might find 

# 1. 'blank' lines including comments 

# 2. keyword/value pairs (which may have trailing comments) 

# 3. enumeration definitions 

# 4. structure definitions 

# 5. data 

# 

lines = self._contents 

# 

# Reattach lines ending with \ 

# 

lines = re.sub(r'\\\s*\n', ' ', lines) 

# 

# Find structure & enumeration definitions & strip them out 

# 

self['symbols']['struct'] = re.findall(r'typedef\s+struct\s*\{[^}]+\}\s*\w+\s*;', lines) 

self['symbols']['enum'] = re.findall(r'typedef\s+enum\s*\{[^}]+\}\s*\w+\s*;', lines) 

lines = re.sub(r'typedef\s+struct\s*\{[^}]+\}\s*\w+\s*;', '', lines) 

lines = re.sub(r'typedef\s+enum\s*\{[^}]+\}\s*\w+\s*;', '', lines) 

# 

# Interpret the structure definitions 

# 

typedefre = re.compile(r'typedef\s+struct\s*\{([^}]+)\}\s*(\w*)\s*;') 

for typedef in self['symbols']['struct']: 

typedefm = typedefre.search(typedef) 

(definition, name) = typedefm.groups() 

self[name.upper()] = dict() 

self['symbols'][name.upper()] = list() 

definitions = re.findall(r'\S+\s+\S+;', definition) 

for d in definitions: 

d = d.replace(';', '') 

(datatype, column) = re.split(r'\s+', d) 

column = re.sub(r'[[<].*[]>]$', '', column) 

self['symbols'][name.upper()].append(column) 

self[name.upper()][column] = list() 

comments = re.compile(r'^\s*#') # Remove lines containing only comments 

blanks = re.compile(r'^\s*$') # Remove lines containing only whitespace 

# 

# Remove trailing comments, but not if they are enclosed in quotes. 

# 

# trailing_comments = re.compile(r'\s*\#.*$') 

# trailing_comments = re.compile(r'\s*\#[^"]+$') 

double_braces = re.compile(r'\{\s*\{\s*\}\s*\}') # Double empty braces get replaced with empty quotes 

if len(lines) > 0: 

for line in lines.split('\n'): 

if self.debug: 

print(line) 

if len(line) == 0: 

continue 

if comments.search(line) is not None: 

continue 

if blanks.search(line) is not None: 

continue 

# 

# Remove leading & trailing blanks & comments 

# 

line = line.strip() 

line = self.trailing_comment(line) 

# line = trailing_comments.sub('',line) 

line = double_braces.sub('""', line) 

# 

# Now if the first word on the line does not match a 

# structure definition it is a keyword/value pair 

# 

(key, value) = self.get_token(line) 

uckey = key.upper() 

if uckey in self['symbols']: 

# 

# Structure data 

# 

for column in self['symbols'][uckey]: 

if len(value) > 0 and blanks.search(value) is None: 

(data, value) = self.get_token(value) 

if self.isarray(uckey, column): 

# 

# An array value 

# if it's character data, it won't be 

# delimited by {} unless it is a multidimensional 

# string array. It may or may not be delimited 

# by double quotes 

# 

# Note, we're assuming here that the only 

# multidimensional arrays are string arrays 

# 

arraydata = list() 

while len(data) > 0: 

(token, data) = self.get_token(data) 

arraydata.append(token) 

self[uckey][column].append( 

self.convert(uckey, column, arraydata)) 

else: 

# 

# A single value 

# 

self[uckey][column].append( 

self.convert(uckey, column, data)) 

else: 

break 

else: 

# 

# Keyword/value pair 

# 

self[key] = value 

# 

# If self.np is True, convert tables into NumPy record arrays 

# 

if self.np: 

for t in self.tables(): 

record = numpy.zeros((self.size(t),), dtype=self.dtype(t)) 

for c in self.columns(t): 

record[c] = self[t][c] 

self[t] = record 

return