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

# Copyright (C) 2015 Chintalagiri Shashank 

# 

# This file is part of Tendril. 

# 

# This program is free software: you can redistribute it and/or modify 

# it under the terms of the GNU Affero General Public License as published by 

# the Free Software Foundation, either version 3 of the License, or 

# (at your option) any later version. 

# 

# This program is distributed in the hope that it will be useful, 

# but WITHOUT ANY WARRANTY; without even the implied warranty of 

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the 

# GNU Affero General Public License for more details. 

# 

# You should have received a copy of the GNU Affero General Public License 

# along with this program.  If not, see <http://www.gnu.org/licenses/>. 

""" 

Electronics Inventory module documentation (:mod:`inventory.electronics`) 

========================================================================= 

""" 

 

import os 

import csv 

 

from tendril.utils.config import ELECTRONICS_INVENTORY_DATA 

from tendril.utils.types.lengths import Length 

from tendril.conventions.electronics import fpiswire_ident 

 

import acquire 

from db.controller import get_inventorylocationcode 

 

from tendril.utils import log 

logger = log.get_logger(__name__, log.INFO) 

 

inventory_locations = [] 

 

 

class InventoryLine(object): 

    def __init__(self, ident, qty=None, parent=None): 

        self._ident = ident 

        self._qty = qty 

        self._parent = parent 

        self._reservations = [] 

 

    @property 

    def ident(self): 

        return self._ident 

 

    @property 

    def avail_qty(self): 

        try: 

            if fpiswire_ident(self._ident): 

                return Length(str(self._qty) + 'm') - self.reserved_qty 

            else: 

                return self._qty - self.reserved_qty 

        except AttributeError: 

            return self._qty - self.reserved_qty 

 

    @property 

    def reserved_qty(self): 

        reserved = 0 

        for reservation in self._reservations: 

            reserved += reservation[0] 

        return reserved 

 

    def reserve_qty(self, value, earmark): 

        try: 

            if fpiswire_ident(self._ident) and not isinstance(value, Length): 

                value = Length(str(value) + 'm') 

        except AttributeError: 

            pass 

        if value > self.avail_qty: 

            raise ValueError 

 

        logger.debug("Reserving " + self.ident + " in " + 

                     self._parent._dname + " for " + earmark + 

                     " : " + str(value)) 

        self._reservations.append((value, earmark)) 

 

    @property 

    def earmarks(self): 

        em = [] 

        for reservation in self._reservations: 

            em.append(reservation[1]) 

        return em 

 

    def _reservation_gen(self): 

        for reservation in self._reservations: 

            yield reservation 

 

    def get_reservation_gen(self): 

        return self._reservation_gen() 

 

    def __repr__(self): 

        return self.ident + '\t' + str(self._qty) + '\t' + \ 

            str(self.reserved_qty) 

 

 

class InventoryLocation(object): 

    def __init__(self, name, dname, reader): 

        self._name = name 

        self._dname = dname 

        self._lines = [] 

        self._code = None 

        self._get_code() 

 

        self._reader = reader 

        if reader is not None: 

            self._load_from_reader() 

 

    def _get_code(self): 

        self._code = get_inventorylocationcode(self._dname) 

 

    @property 

    def name(self): 

        return self._dname 

 

    def _load_from_reader(self): 

        for (ident, qty) in self._reader.tf_row_gen: 

            self._lines.append(InventoryLine(ident, qty, self)) 

 

    def get_ident_qty(self, ident): 

        avail_qty = 0 

        is_here = False 

        for line in self._lines: 

            if line.ident == ident: 

                is_here = True 

                avail_qty += line.avail_qty 

        if is_here: 

            logger.debug("Found " + ident + " in " + self._dname + 

                         " : " + str(avail_qty)) 

            # if fpiswire_ident(ident): 

            #     avail_qty = Length(str(avail_qty)+'m') 

            return avail_qty 

        else: 

            return None 

 

    def get_reserve_qty(self, ident): 

        reserve_qty = 0 

        is_here = False 

        for line in self._lines: 

            if line.ident == ident: 

                is_here = True 

                reserve_qty += line.reserved_qty 

        if is_here: 

            return reserve_qty 

        else: 

            return None 

 

    def reserve_ident_qty(self, ident, qty, earmark): 

        for line in self._lines: 

            if line.ident == ident: 

                if line.avail_qty > qty: 

                    line.reserve_qty(qty, earmark) 

                    return 0 

                elif line.avail_qty > 0: 

                    qty = qty - line.avail_qty 

                    line.reserve_qty(line.avail_qty, earmark) 

        if qty > 0: 

            raise ValueError("Unexpected Overrequisition : " + ident) 

        return qty 

 

    @property 

    def earmarks(self): 

        earmarks = [] 

        for line in self._lines: 

            for em in line.earmarks: 

                if em not in earmarks: 

                    earmarks.append(em) 

        return earmarks 

 

    def _reservation_gen(self): 

        for line in self._lines: 

            if line.reserved_qty > 0: 

                yield (line.ident, line.get_reservation_gen()) 

 

    def get_reservation_gen(self): 

        return self._reservation_gen() 

 

    def commit_reservations(self): 

        pass 

 

    @property 

    def lines(self): 

        return self._lines 

 

 

def init_inventory_locations(): 

    for idx, item in enumerate(ELECTRONICS_INVENTORY_DATA): 

        logger.info("Acquiring Inventory Location : " + item['location']) 

        reader = acquire.get_reader(idx) 

        inventory_locations.append( 

            InventoryLocation(item['sname'], item['location'], reader) 

        ) 

 

 

def get_total_availability(ident): 

    total_avail = 0 

    for location in inventory_locations: 

        lqty = location.get_ident_qty(ident) 

        if lqty is not None: 

            total_avail += lqty 

    return total_avail 

 

 

def get_total_reservations(ident): 

    total_reserve = 0 

    for location in inventory_locations: 

        lqty = location.get_reserve_qty(ident) 

        if lqty is not None: 

            total_reserve += lqty 

    return total_reserve 

 

 

def reserve_items(ident, qty, earmark, die_if_not=True): 

    if qty <= 0: 

        raise ValueError 

    if fpiswire_ident(ident) and not isinstance(qty, Length): 

        qty = Length(str(qty) + 'm') 

    for location in inventory_locations: 

        lqty = location.get_ident_qty(ident) 

        if lqty is not None: 

            if lqty > qty: 

                location.reserve_ident_qty(ident, qty, earmark) 

                return 0 

            elif lqty > 0: 

                location.reserve_ident_qty(ident, lqty, earmark) 

                qty -= lqty 

        if qty == 0: 

            return 0 

    if qty > 0: 

        logger.warning('Partial Reservation of ' + ident + 

                       ' for ' + earmark + ' : Short by ' + str(qty)) 

        if die_if_not is True: 

            raise ValueError("Insufficient Qty. " 

                             "Call with die_if_not=True if handled downstream" 

                             ) 

    return qty 

 

 

def export_reservations(folderpath): 

    earmarks = [] 

    for location in inventory_locations: 

        for em in location.earmarks: 

            if em not in earmarks: 

                earmarks.append(em) 

    for location in inventory_locations: 

        dump_path = os.path.join(folderpath, 

                                 'reserve-' + location._dname + '.csv') 

        with open(dump_path, 'wb') as f: 

            w = csv.writer(f) 

            header = ['Ident'] + earmarks + ['Total', 'Remaining'] 

            w.writerow(header) 

            for ident, emgen in location.get_reservation_gen(): 

                row = [ident] + [0] * (len(earmarks) + 2) 

                total = 0 

                for reservation in emgen: 

                    row[earmarks.index(reservation[1]) + 1] += reservation[0] 

                    total += reservation[0] 

                for idx, hdr in enumerate(earmarks): 

                    if row[idx + 1] == 0: 

                        row[idx + 1] = '' 

                row[header.index('Total')] = total 

                row[header.index('Remaining')] = get_total_availability(ident) 

                w.writerow(row) 

        logger.info("Exported " + location._dname + 

                    " Reservations to File : " + dump_path) 

 

init_inventory_locations()