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

# Copyright 2009-2014 Luc Saffre 

# License: BSD (see file COPYING for details) 

 

"""Defines the :class:`Instantiator` class and some other utilities 

used for generating database objects in :ref:`python fixtures <dpy>`. 

 

Example values: 

 

>>> s = '<a href="javascript:Lino.pcsw.Clients.detail.run(\ 

null,{ &quot;record_id&quot;: 116 })">BASTIAENSEN Laurent (116)</a>' 

>>> GFK_HACK.match(s).groups() 

(u'pcsw.Clients', u'116') 

 

>>> s = '<a href="javascript:Lino.cal.Guests.detail.run(\ 

null,{ &quot;record_id&quot;: 6 })">Gast #6 ("Termin #51")</a>' 

>>> GFK_HACK.match(s).groups() 

(u'cal.Guests', u'6') 

 

""" 

 

from __future__ import unicode_literals 

from __future__ import print_function 

from builtins import str 

from past.builtins import basestring 

from builtins import object 

 

 

import re 

GFK_HACK = re.compile(r'^<a href="javascript:Lino\.(\w+\.\w+)\.detail\.run\(.*,\{ &quot;record_id&quot;: (\w+) \}\)">.*</a>$') 

 

import logging 

logger = logging.getLogger(__name__) 

 

 

import decimal 

import datetime 

from dateutil import parser as dateparser 

 

from django.db import models 

from django.conf import settings 

 

from lino.core.utils import resolve_model, UnresolvedModel 

 

from lino.utils import i2d  # for backward compatibility of .py fixtures 

from lino.core.utils import obj2str 

 

from lino import AFTER17 

 

 

class DataError(Exception): 

    pass 

 

 

class Converter(object): 

 

    def __init__(self, field): 

        self.field = field 

 

    def convert(self, **kw): 

        return kw 

 

 

class LookupConverter(Converter): 

 

    """ 

    A Converter for ForeignKey and ManyToManyField.  

    If the lookup_field is a BabelField, then it tries all available languages. 

    """ 

 

    def __init__(self, field, lookup_field): 

        Converter.__init__(self, field) 

        model = field.rel.model 

        if lookup_field == 'pk': 

            self.lookup_field = model._meta.pk 

        else: 

            self.lookup_field = model._meta.get_field(lookup_field) 

        #~ self.lookup_field = lookup_field 

 

    def lookup(self, value, **kw): 

        model = self.field.rel.model 

        if isinstance(value, model): 

            return value 

        return model.lookup_or_create(self.lookup_field, value, **kw) 

 

        #~ if isinstance(self.lookup_field,babel.BabelCharField): 

            #~ flt  = babel.lookup_filter(self.lookup_field.name,value,**kw) 

        #~ else: 

            #~ kw[self.lookup_field.name] = value 

            #~ flt = models.Q(**kw) 

        #~ try: 

            #~ return model.objects.get(flt) 

        #~ except MultipleObjectsReturned,e: 

            #~ raise model.MultipleObjectsReturned("%s.objects lookup(%r) : %s" % (model.__name__,value,e)) 

        #~ except model.DoesNotExist,e: 

            #~ raise model.DoesNotExist("%s.objects lookup(%r) : %s" % (model.__name__,value,e)) 

 

 

class DateConverter(Converter): 

 

    def convert(self, **kw): 

        value = kw.get(self.field.name) 

        if value is not None: 

            if not isinstance(value, datetime.date): 

                if type(value) == int: 

                    value = str(value) 

                d = dateparser.parse(value) 

                d = datetime.date(d.year, d.month, d.day) 

                kw[self.field.name] = d 

        return kw 

 

 

class ChoiceConverter(Converter): 

 

    """Converter for :class:`ChoiceListField <lino.core.choicelists.ChoiceListField>`. 

    """ 

 

    def convert(self, **kw): 

        value = kw.get(self.field.name) 

 

        if value is not None: 

            if not isinstance(value, self.field.choicelist.item_class): 

                kw[self.field.name] = self.field.choicelist.get_by_value(value) 

        return kw 

 

 

class DecimalConverter(Converter): 

 

    def convert(self, **kw): 

        value = kw.get(self.field.name) 

        if value is not None: 

            if not isinstance(value, decimal.Decimal): 

                kw[self.field.name] = decimal.Decimal(value) 

        return kw 

 

 

class ForeignKeyConverter(LookupConverter): 

 

    """Converter for ForeignKey fields.""" 

 

    def convert(self, **kw): 

        value = kw.get(self.field.name) 

        if value is not None: 

            if value == '': 

                value = None 

            else: 

                value = self.lookup(value) 

            kw[self.field.name] = value 

            #~ logger.info("20111213 %s %s -> %r", self.field.name,self.__class__,value) 

        return kw 

 

 

class GenericForeignKeyConverter(Converter): 

 

    """Converter for GenericForeignKey fields.""" 

 

    def convert(self, **kw): 

        value = kw.get(self.field.name) 

        if value is not None: 

            if value == '': 

                value = None 

            else: 

                mo = GFK_HACK.match(value) 

                if mo is not None: 

                    actor = settings.SITE.modules.resolve(mo.group(1)) 

                    pk = mo.group(2) 

                    value = actor.get_row_by_pk(None, pk) 

                    # ct = ContentType.objects.get_for_model(actor.model) 

                    # value = self.lookup(value) 

                else: 

                    raise Exception("Could not parse %r" % value) 

            kw[self.field.name] = value 

        return kw 

 

 

class ManyToManyConverter(LookupConverter): 

 

    """Converter for ManyToMany fields.""" 

    splitsep = None 

 

    #~ def lookup(self,value): 

        #~ model = self.field.rel.model 

        #~ try: 

            #~ return model.objects.get( 

              #~ **{self.lookup_field: value}) 

        #~ except model.DoesNotExist,e: 

            #~ raise DataError("%s.objects.get(%r) : %s" % ( 

              #~ model.__name__,value,e)) 

 

    def convert(self, **kw): 

        values = kw.get(self.field.name) 

        if values is not None: 

            del kw[self.field.name] 

            l = [self.lookup(value) 

                 for value in values.split(self.splitsep)] 

            kw['_m2m'][self.field.name] = l 

        return kw 

 

 

def make_converter(f, lookup_fields={}): 

    from lino.core.gfks import GenericForeignKey 

 

    if isinstance(f, models.ForeignKey): 

        return ForeignKeyConverter(f, lookup_fields.get(f.name, "pk")) 

    if isinstance(f, GenericForeignKey): 

        return GenericForeignKeyConverter(f) 

    #~ if isinstance(f,fields.LinkedForeignKey): 

        #~ return LinkedForeignKeyConverter(f,lookup_fields.get(f.name,"pk")) 

    if isinstance(f, models.ManyToManyField): 

        return ManyToManyConverter(f, lookup_fields.get(f.name, "pk")) 

    if isinstance(f, models.DateField): 

        return DateConverter(f) 

    if isinstance(f, models.DecimalField): 

        return DecimalConverter(f) 

    from lino.core import choicelists 

    if isinstance(f, choicelists.ChoiceListField): 

        #~ if f.name == 'p_book': 

            #~ print "20131012 b", f 

        return ChoiceConverter(f) 

 

 

class Instantiator(object): 

    """A utility class to make python fixtures more compact. See 

    :ref:`tutorial.instantiator`. 

 

    An instantiator is a 

 

    """ 

 

    def __init__(self, model, fieldnames=None, converter_classes={}, **kw): 

        #~ self.model = resolve_model(model,strict=True) 

        self.model = resolve_model(model) 

        if isinstance(self.model, UnresolvedModel): 

            raise Exception("Instantiator on unresolved model %s", model) 

        if not self.is_active(): 

            def noop(*values, **kw): 

                pass 

            self.build = noop 

            return 

        #~ if self.model._meta.pk is None: 

            #~ raise Exception("Model %r is not installed (_meta.pk is None)." % self.model) 

        #~ if type(fieldnames) == str: 

        if isinstance(fieldnames, basestring): 

            fieldnames = fieldnames.split() 

        self.default_values = kw 

        #self.fieldnames = fieldnames 

        lookup_fields = {} 

        self.converters = [] 

        if fieldnames is None: 

            self.fields = self.model._meta.fields 

        else: 

            self.fields = [] 

            for name in fieldnames: 

                a = name.split(":") 

                if len(a) == 2: 

                    name = a[0] 

                    lookup_fields[name] = a[1] 

                field = self.model._meta.get_field(name) 

                self.fields.append(field) 

        # print " ".join(dir(model_class)) 

        # print " ".join(model_class._meta.fields) 

        # for f in model_class._meta.fields: 

        # for f in self.fields: 

        for f in self.model._meta.fields + self.model._meta.many_to_many: 

            cv = None 

            cvc = converter_classes.get(f.name, None) 

            if cvc is not None: 

                cv = cvc(f) 

            else: 

                cv = make_converter(f, lookup_fields) 

            if cv is not None: 

                self.converters.append(cv) 

        #~ for f in model_class._meta.many_to_many: 

            #~ print "foo", f.name 

 

    def is_active(self): 

 

        if isinstance(self.model, UnresolvedModel): 

            return False 

        if self.model._meta.pk is None: 

            return False 

        return True 

 

    def __call__(self, *values, **kw): 

        """Calling an instantiator is the same as callig its :meth:`build` 

        method. 

 

        """ 

        return self.build(*values, **kw) 

 

    def build(self, *values, **kw): 

        """Instantiate an object using the default values of this 

        instantiator, overridden by the given specified values. The 

        number of positional arguments may not exceed the number of 

        fieldnames specified when creating this :class:`Instantiator`. 

 

        """ 

        # logger.debug("Instantiator.build(%s,%r,%r)",self.model_class._meta.db_table,values,kw) 

        #~ i = 0 

        kw['_m2m'] = {} 

        for i, v in enumerate(values): 

            if isinstance(v, basestring): 

                v = v.strip() 

                if len(v) > 0: 

                    kw[self.fields[i].name] = v 

            else: 

                kw[self.fields[i].name] = v 

            #~ i += 1 

        #~ kw.update(self.default_values) 

        for k, v in list(self.default_values.items()): 

            kw.setdefault(k, v) 

        for c in self.converters: 

            kw = c.convert(**kw) 

        #~ if self.model.__name__ == 'Company': 

            #~ print 20130212, __file__, kw 

            #~ logger.info("20130212 field_cache for %s (%s)",self.model, 

              #~ ' '.join([f.name for f in self.model._meta._field_name_cache])) 

 

        m2m = kw.pop("_m2m") 

        instance = self.model(**kw) 

        instance.full_clean() 

        if m2m: 

            instance.save() 

            for k, v in list(m2m.items()): 

                queryset = getattr(instance, k) 

                queryset.add(*v) 

        return instance 

 

 

class InstanceGenerator(object): 

    """ 

    Usage example see :mod:`lino_xl.lib.humanlinks.fixtures`. 

    """ 

    def __init__(self): 

        self._objects = [] 

        self._instantiators = dict() 

 

    def add_instantiator(self, name, *args, **kw): 

        i = Instantiator(*args, **kw) 

        # self._instantiators[i.model] = i 

 

        def f(*args, **kw): 

            o = i.build(*args, **kw) 

            return self.on_new(o) 

        setattr(self, name, f) 

 

    def on_new(self, o): 

        self._objects.append(o) 

        return o 

 

    def flush(self): 

        rv = self._objects 

        self._objects = [] 

        return rv 

 

 

def create_and_get(model, **kw): 

    """ 

    Instantiate, full_clean, save  

    and read back from database (the latter to avoid certain Django side effects) 

    """ 

    model = resolve_model(model) 

    o = model(**kw) 

    o.full_clean() 

    o.save() 

    return model.objects.get(pk=o.pk) 

 

 

def _test(): 

    import doctest 

    doctest.testmod() 

 

if __name__ == "__main__": 

    _test()